Update continuous integration and Update Readme (#69)

Author: ConnorRigby

.circleci/config.yml

@@ -0,0 +1,26 @@
+version: 2.0
+jobs:
+  build:
+    docker:
+      - image: circleci/elixir:1.6.6-otp-21
+    environment:
+      MIX_ENV: test
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-dependency-cache-{{ checksum "mix.lock" }}
+      - run: mix local.hex --force
+      - run: mix local.rebar --force
+      - run: mix deps.get
+      - run: mix deps.compile
+      - run: mix compile
+      # not passing yet
+      # - run: mix credo --strict
+      - run: mix coveralls.circle
+      - run: mix inch.report
+      - save_cache:
+          key: v2-dependency-cache-{{ checksum "mix.lock" }}
+          paths:
+            - _build
+            - deps

.credo.exs

@@ -0,0 +1,88 @@
+%{configs: [
+  %{name: "default",
+    files: %{
+      included: ["lib/", "test/", "integration/"],
+      excluded: [~r"/_build/", ~r"/deps/"]
+    },
+    requires: [],
+    check_for_updates: false,
+
+    # You can customize the parameters of any check by adding a second element
+    # to the tuple.
+    #
+    # To disable a check put `false` as second element:
+    #
+    #     {Credo.Check.Design.DuplicatedCode, false}
+    #
+    checks: [
+      {Credo.Check.Consistency.ExceptionNames},
+      {Credo.Check.Consistency.LineEndings},
+      {Credo.Check.Consistency.MultiAliasImportRequireUse},
+      {Credo.Check.Consistency.ParameterPatternMatching},
+      {Credo.Check.Consistency.SpaceAroundOperators},
+      {Credo.Check.Consistency.SpaceInParentheses},
+      {Credo.Check.Consistency.TabsOrSpaces},
+
+      {Credo.Check.Design.AliasUsage, false},
+      {Credo.Check.Design.DuplicatedCode, excluded_macros: []},
+
+      # Disabled for now as those are checked by Code Climate
+      {Credo.Check.Design.TagTODO, false},
+      {Credo.Check.Design.TagFIXME, false},
+
+      {Credo.Check.Readability.FunctionNames},
+      {Credo.Check.Readability.LargeNumbers},
+      {Credo.Check.Readability.MaxLineLength, false},
+      {Credo.Check.Readability.ModuleAttributeNames},
+      {Credo.Check.Readability.ModuleDoc},
+      {Credo.Check.Readability.ModuleNames},
+      {Credo.Check.Readability.ParenthesesInCondition},
+      {Credo.Check.Readability.PredicateFunctionNames},
+      {Credo.Check.Readability.PreferImplicitTry, false},
+      {Credo.Check.Readability.RedundantBlankLines},
+      {Credo.Check.Readability.Semicolons},
+      {Credo.Check.Readability.SinglePipe, false},
+        # ^^ Ecto does this quite a bit and we want to follow their
+        # code format closely, so silence this warning.
+
+      {Credo.Check.Readability.SpaceAfterCommas},
+      {Credo.Check.Readability.Specs, false},
+      {Credo.Check.Readability.StringSigils, false},
+        # ^^ Ecto does this quite a bit and we want to follow their
+        # code format closely, so silence this warning.
+
+      {Credo.Check.Readability.TrailingBlankLine},
+      {Credo.Check.Readability.TrailingWhiteSpace},
+      {Credo.Check.Readability.VariableNames},
+      {Credo.Check.Readability.RedundantBlankLines},
+
+      {Credo.Check.Refactor.ABCSize, false},
+      {Credo.Check.Refactor.CondStatements},
+      {Credo.Check.Refactor.CyclomaticComplexity},
+      {Credo.Check.Refactor.DoubleBooleanNegation, false},
+      {Credo.Check.Refactor.FunctionArity, max_arity: 8},
+      {Credo.Check.Refactor.MatchInCondition},
+      {Credo.Check.Refactor.PipeChainStart, false},
+      {Credo.Check.Refactor.NegatedConditionsInUnless},
+      {Credo.Check.Refactor.NegatedConditionsWithElse},
+      {Credo.Check.Refactor.Nesting},
+      {Credo.Check.Refactor.UnlessWithElse},
+      {Credo.Check.Refactor.VariableRebinding, false},
+
+      {Credo.Check.Warning.BoolOperationOnSameValues},
+      {Credo.Check.Warning.IExPry},
+      {Credo.Check.Warning.IoInspect, false},
+      {Credo.Check.Warning.OperationOnSameValues, false},
+        # Disabled because of p.x == p.x in Ecto queries
+      {Credo.Check.Warning.OperationWithConstantResult},
+      {Credo.Check.Warning.UnusedEnumOperation},
+      {Credo.Check.Warning.UnusedFileOperation},
+      {Credo.Check.Warning.UnusedKeywordOperation},
+      {Credo.Check.Warning.UnusedListOperation},
+      {Credo.Check.Warning.UnusedPathOperation},
+      {Credo.Check.Warning.UnusedRegexOperation},
+      {Credo.Check.Warning.UnusedStringOperation},
+      {Credo.Check.Warning.UnusedTupleOperation},
+    ]
+  }
+]}

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["mix.exs", "{config,lib,test,bench}/**/*.{ex,exs}"]
+]

.gitignore

@@ -5,4 +5,3 @@ erl_crash.dump
 *.ez
 /doc
 /docs
-mix.lock

.tool-versions

@@ -0,0 +1,2 @@
+erlang 21.0.1
+elixir 1.6.6-otp-21

.travis.yml

@@ -1,22 +1,20 @@
-[![Build Status](https://travis-ci.org/mmmries/sqlitex.svg?branch=master)](https://travis-ci.org/mmmries/sqlitex)
-[![Inline docs](http://inch-ci.org/github/mmmries/sqlitex.svg?branch=master)](http://inch-ci.org/github/mmmries/sqlitex)
+[![CircleCI](https://circleci.com/gh/Sqlite-Ecto/sqlitex.svg?style=svg)](https://circleci.com/gh/Sqlite-Ecto/sqlitex)
+[![Coverage Status](https://coveralls.io/repos/github/Sqlite-Ecto/sqlitex/badge.svg?branch=master)](https://coveralls.io/github/Sqlite-Ecto/sqlitex?branch=master)
+[![Inline docs](http://inch-ci.org/github/Sqlite-Ecto/sqlitex.svg)](http://inch-ci.org/github/Sqlite-Ecto/sqlitex)
 [![Hex.pm](https://img.shields.io/hexpm/v/sqlitex.svg)](https://hex.pm/packages/sqlitex)
 [![Hex.pm](https://img.shields.io/hexpm/dt/sqlitex.svg)](https://hex.pm/packages/sqlitex)
 
-Sqlitex
-=======
+# Sqlitex
 
 An Elixir wrapper around [esqlite](https://github.com/mmzeeman/esqlite). The main aim here is to provide convenient usage of sqlite databases.
 
-Updated to 1.0
-==============
+# Updated to 1.0
 
 With the 1.0 release we made just a single breaking change. `Sqlitex.Query.query` previously returned just the raw query results on success and `{:error, reason}` on failure.
 This has been bothering us for a while so we changed it in 1.0 to return `{:ok, results}` on success and `{:error, reason}` on failure.
 This should make it easier to pattern match on. The `Sqlitex.Query.query!` function has kept its same functionality of returning bare results on success and raising an error on failure.
 
-Usage
-=====
+# Usage
 
 The simple way to use sqlitex is just to open a database and run a query
 
@@ -65,9 +63,5 @@ Sqlitex.Server.query(Golf.DB,
                       ORDER BY g.played_at DESC LIMIT 10")
 ```
 
-Plans
-=====
-
-I started this project mostly as a way to learn about Elixir.
-Some other people have found it useful and have done the hard work to make it work with ecto [v1.X](https://github.com/jazzyb/sqlite_ecto) and [v2.X](https://github.com/scouten/sqlite_ecto2).
-I'm not currently using this for any production-level projects, but I'm happy to continue maintaining it as long as people find it useful.
+# Looking for Ecto?
+Check out the [Sqlite Ecto2 adapter](https://github.com/Sqlite-Ecto/sqlite_ecto2)

README.md

@@ -5,12 +5,13 @@ defmodule Sqlitex.Mixfile do
     [
       app: :sqlitex,
       version: "1.4.2",
-      elixir: "~> 1.2",
+      elixir: "~> 1.4",
       deps: deps(),
       package: package(),
       test_coverage: [tool: ExCoveralls],
       preferred_cli_env: [
-         "coveralls": :test,
+         coveralls: :test,
+         "coveralls.circle": :test,
          "coveralls.detail": :test,
          "coveralls.post": :test,
          "coveralls.html": :test],
@@ -23,32 +24,29 @@ defmodule Sqlitex.Mixfile do
 
   # Configuration for the OTP application
   def application do
-    [applications: [:logger, :esqlite]]
+    [extra_applications: [:logger]]
   end
 
   # Type `mix help deps` for more examples and options
   defp deps do
     [
       {:esqlite, "~> 0.2.4"},
-      {:decimal, "~> 1.1"},
-
-      {:credo, "~> 0.4", only: :dev},
-      {:dialyxir, "~> 0.5.1", only: :dev, runtime: false},
-      {:earmark, "~> 1.2", only: :dev},
-      {:excoveralls, "~> 0.6", only: :test},
-      {:ex_doc, "~> 0.18", only: :dev},
-      {:inch_ex, "~> 0.5", only: :dev},
-
-      {:excheck, "~> 0.5", only: :test},
+      {:decimal, "~> 1.5"},
+      {:credo, "~> 0.10", only: :dev},
+      {:dialyxir, "~> 1.0.0-rc.3", only: :dev, runtime: false},
+      {:excoveralls, "~> 0.9", only: :test},
+      {:ex_doc, "~> 0.18", only: :docs, runtime: false},
+      {:excheck, "~> 0.6", only: :test},
+      {:inch_ex, "~> 1.0", only: :test},
       {:triq, "~> 1.2", only: :test},
     ]
   end
 
   defp package do
-   [maintainers: ["Michael Ries", "Jason M Barnes", "Graeme Coupar", "Eric Scouten"],
+   [maintainers: ["Michael Ries", "Jason M Barnes", "Graeme Coupar", "Eric Scouten", "Connor Rigby"],
      licenses: ["MIT"],
      links: %{
-      github: "https://github.com/mmmries/sqlitex",
+      github: "https://github.com/Sqlite-Ecto/sqlitex",
       docs: "http://hexdocs.pm/sqlitex"}]
   end
 end

mix.exs

@@ -0,0 +1,23 @@
+%{
+  "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"},
+  "certifi": {:hex, :certifi, "2.3.1", "d0f424232390bf47d82da8478022301c561cf6445b5b5fb6a84d49a9e76d2639", [:rebar3], [{:parse_trans, "3.2.0", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"},
+  "credo": {:hex, :credo, "0.10.0", "66234a95effaf9067edb19fc5d0cd5c6b461ad841baac42467afed96c78e5e9e", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},
+  "decimal": {:hex, :decimal, "1.5.0", "b0433a36d0e2430e3d50291b1c65f53c37d56f83665b43d79963684865beab68", [:mix], [], "hexpm"},
+  "dialyxir": {:hex, :dialyxir, "1.0.0-rc.3", "774306f84973fc3f1e2e8743eeaa5f5d29b117f3916e5de74c075c02f1b8ef55", [:mix], [], "hexpm"},
+  "earmark": {:hex, :earmark, "1.2.5", "4d21980d5d2862a2e13ec3c49ad9ad783ffc7ca5769cf6ff891a4553fbaae761", [:mix], [], "hexpm"},
+  "esqlite": {:hex, :esqlite, "0.2.4", "3a8a352c190afe2d6b828b252a6fbff65b5cc1124647f38b15bdab3bf6fd4b3e", [:rebar3], [], "hexpm"},
+  "ex_doc": {:hex, :ex_doc, "0.18.4", "4406b8891cecf1352f49975c6d554e62e4341ceb41b9338949077b0d4a97b949", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
+  "excheck": {:hex, :excheck, "0.6.0", "f8595a8ac2c0abc0d060c1a4fce7d26f41574543366a52d5f3c84de30a69747b", [:mix], [], "hexpm"},
+  "excoveralls": {:hex, :excoveralls, "0.9.1", "14fd20fac51ab98d8e79615814cc9811888d2d7b28e85aa90ff2e30dcf3191d6", [:mix], [{:hackney, ">= 0.12.0", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},
+  "hackney": {:hex, :hackney, "1.13.0", "24edc8cd2b28e1c652593833862435c80661834f6c9344e84b6a2255e7aeef03", [:rebar3], [{:certifi, "2.3.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.2", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
+  "idna": {:hex, :idna, "5.1.2", "e21cb58a09f0228a9e0b95eaa1217f1bcfc31a1aaa6e1fdf2f53a33f7dbd9494", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},
+  "inch_ex": {:hex, :inch_ex, "1.0.0", "18496a900ca4b7542a1ff1159e7f8be6c2012b74ca55ac70de5e805f14cdf939", [:mix], [{:poison, "~> 1.5 or ~> 2.0 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"},
+  "jason": {:hex, :jason, "1.1.1", "d3ccb840dfb06f2f90a6d335b536dd074db748b3e7f5b11ab61d239506585eb2", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm"},
+  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm"},
+  "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm"},
+  "parse_trans": {:hex, :parse_trans, "3.2.0", "2adfa4daf80c14dc36f522cf190eb5c4ee3e28008fc6394397c16f62a26258c2", [:rebar3], [], "hexpm"},
+  "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"},
+  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], [], "hexpm"},
+  "triq": {:hex, :triq, "1.2.0", "3fbf99c16671f084b558f7e799e38d92835d67dcc012fb40d418330ea1053455", [:rebar3], [], "hexpm"},
+  "unicode_util_compat": {:hex, :unicode_util_compat, "0.3.1", "a1f612a7b512638634a603c8f401892afbf99b8ce93a45041f8aaca99cadb85e", [:rebar3], [], "hexpm"},
+}