spine-parameters 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dab244a1431bc85f9228234dc4ab23c7c62e9e3a
-  data.tar.gz: 4a50821b5a0d43fda17976e0630c263c18a7c986
+  metadata.gz: 8da37b80aed3f2b00511ff9e46697b999efa68da
+  data.tar.gz: 2409b7ac4da2049abf696605b675724348c11199
 SHA512:
-  metadata.gz: 1276dc40bf34972fd32bf313ae0d77a80affdf59cdbb627eeba358db038cdfb8a4e20db557da91be485a32811ba650e486b84ec9a98f25243485a88e2598e066
-  data.tar.gz: 54b21ed9574442236907cb8d0b70a7319877a0b5cc6460c52fd114613573be22400dc4d39383a4b1f734be3f1fe57871aafd51283f8898cd1dd7adaae7226ae0
+  metadata.gz: da605a66e6b10193ebfd68d02a3316d4466eeebc4f0e324c193f50a915c85953da6f148c89f8a1a86fdc780c60bafec71b9adfa54faf3edc70a15e9278c76df0
+  data.tar.gz: 4cf4749ea26a4a5d06affcf412d49d4a314653c5a392a42692e13d0ad997af47d0acf1481d8ef732ec4864d36179c0304a5fe5f80a6ac825c1b2182b4eb6af78

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 Changelog
 =========
 
+0.3.0
+-----
+-   Adds list parameter type which can handle Enumerables and Strings (comma separated list)
 0.2.0
 -----
 -   Adds parameters extension for controllers/actions

data/Gemfile.lock

@@ -7,26 +7,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    codeclimate-test-reporter (0.4.7)
+    codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    json (1.8.2)
-    rake (10.4.2)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    json (1.8.3)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    simplecov (0.10.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
@@ -37,8 +37,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
+  bundler (~> 1.10)
   codeclimate-test-reporter (~> 0.4)
   rake (~> 10.0)
-  rspec (~> 3.2)
+  rspec (~> 3)
   spine-parameters!
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -4,7 +4,9 @@
 [![Dependency Status](https://gemnasium.com/rspine/parameters.svg)](https://gemnasium.com/rspine/parameters)
 [![Test Coverage](https://codeclimate.com/github/rspine/parameters/badges/coverage.svg)](https://codeclimate.com/github/rspine/parameters/coverage)
 [![Code Climate](https://codeclimate.com/github/rspine/parameters/badges/gpa.svg)](https://codeclimate.com/github/rspine/parameters)
-[ ![Codeship Status for rspine/parameters](https://codeship.com/projects/c3d614e0-e11c-0132-df07-763d3ae4d225/status?branch=master)](https://codeship.com/projects/81066)
+[![security](https://hakiri.io/github/rspine/parameters/master.svg)](https://hakiri.io/github/rspine/parameters/master)
+[![Inline docs](http://inch-ci.org/github/rspine/parameters.svg?branch=master)](http://inch-ci.org/github/rspine/parameters)
+[![Codeship Status for rspine/parameters](https://codeship.com/projects/c3d614e0-e11c-0132-df07-763d3ae4d225/status?branch=master)](https://codeship.com/projects/81066)
 
 Validates and converts parameters. Also it converts all keys to symbols.
 
@@ -25,6 +27,8 @@ parameters = Spine::Parameters::Collection.new(parameters_containing_hash)
 parameters.required(:name)
   .integer(:id)
   .timestamp(:since)
+  .boolean(:valid)
+  .list(:favourites)
 
 parameters.errors? # Checks if there is any parsing error.
 parameters.errors

data/lib/spine/parameters.rb

@@ -10,12 +10,24 @@ module Spine
       autoload :Timestamp, 'spine/parameters/syntax/timestamp'
       autoload :Boolean, 'spine/parameters/syntax/boolean'
       autoload :Required, 'spine/parameters/syntax/required'
+      autoload :List, 'spine/parameters/syntax/list'
     end
 
     module Parsers
       autoload :Integer, 'spine/parameters/parsers/integer'
       autoload :Timestamp, 'spine/parameters/parsers/timestamp'
       autoload :Boolean, 'spine/parameters/parsers/boolean'
+      autoload :Anything, 'spine/parameters/parsers/anything'
+      autoload :String, 'spine/parameters/parsers/string'
+      autoload :List, 'spine/parameters/parsers/list'
+
+      ALL = {
+        anything: Parsers::Anything,
+        string: Parsers::String,
+        integer: Parsers::Integer,
+        boolean: Parsers::Boolean,
+        timestamp: Parsers::Timestamp
+      }
     end
   end
 end

data/lib/spine/parameters/collection.rb

@@ -8,6 +8,7 @@ module Spine
       include Syntax::Boolean
       include Syntax::Constraint
       include Syntax::Required
+      include Syntax::List
       include Errors
 
       attr_reader :raw, :values

data/lib/spine/parameters/parsers/anything.rb

@@ -0,0 +1,13 @@
+module Spine
+  module Parameters
+    module Parsers
+      module Anything
+        extend self
+
+        def parse(name, value)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/spine/parameters/parsers/list.rb

@@ -0,0 +1,29 @@
+module Spine
+  module Parameters
+    module Parsers
+      class List
+        def initialize(parser = Parsers::Anything)
+          @parser = parser
+        end
+
+        def parse(name, value)
+          return [] unless value
+          return parse_collection(value) if value.is_a?(Enumerable)
+          return parse_collection(value.split(',')) if value.is_a?(::String)
+
+          raise ArgumentError.new
+        end
+
+        private
+
+        def parse_collection(collection)
+          collection.map { |item| parse_element(item) }
+        end
+
+        def parse_element(element)
+          @parser.parse(nil, element)
+        end
+      end
+    end
+  end
+end

data/lib/spine/parameters/parsers/string.rb

@@ -0,0 +1,13 @@
+module Spine
+  module Parameters
+    module Parsers
+      module String
+        extend self
+
+        def parse(name, value)
+          value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/spine/parameters/syntax/list.rb

@@ -0,0 +1,20 @@
+module Spine
+  module Parameters
+    module Syntax
+      module List
+        def list(name, options = {}, &block)
+          parse(name, Parsers::List.new(list_parser(options[:type])), &block)
+        rescue ArgumentError
+          add_error(name, 'is not a list.')
+          self
+        end
+
+        private
+
+        def list_parser(type)
+          Parsers::ALL.fetch(type, Parsers::Anything)
+        end
+      end
+    end
+  end
+end

data/lib/spine/parameters/version.rb

@@ -1,5 +1,5 @@
 module Spine
   module Parameters
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/spine/parameters/parameters_spec.rb

@@ -10,7 +10,11 @@ module Spine
         {
           "selected_account_id"=>"1",
           "some_timestamp" => "2015-01-12T10:42:36+02:00",
-          "google_login" => "true"
+          "google_login" => "true",
+          "favourites" => "1,2,3",
+          "parsed_list" => ['1', '2'],
+          "parsed_integer" => 1,
+          "parsed_map" => { key: 'value' }
         }
       }
 
@@ -19,6 +23,47 @@ module Spine
         expect(subject[:some_timestamp]).to be
       end
 
+      context "when parsing list" do
+        it "returns valid array" do
+          subject.list(:favourites)
+          expect(subject[:favourites]).to eq(['1', '2', '3'])
+        end
+
+        it "returns valid array of specified type" do
+          subject.list(:favourites, type: :integer)
+          expect(subject[:favourites]).to eq([1, 2, 3])
+        end
+
+        it "has errors if list is not parsed" do
+          subject.list(:parsed_integer)
+          expect(subject.errors?).to be
+        end
+      end
+
+      context "when parsing parsed list" do
+        it "returns valid array" do
+          subject.list(:parsed_list)
+          expect(subject[:parsed_list]).to eq(['1', '2'])
+        end
+
+        it "returns valid array of specified type" do
+          subject.list(:parsed_list, type: :integer)
+          expect(subject[:parsed_list]).to eq([1, 2])
+        end
+      end
+
+      context "when parsing parsed map" do
+        it "returns valid array" do
+          subject.list(:parsed_map)
+          expect(subject[:parsed_map]).to eq([[:key, 'value']])
+        end
+
+        it "has errors" do
+          subject.list(:parsed_map, type: :integer)
+          expect(subject.errors?).to be
+        end
+      end
+
       context "when parsing integer" do
         it "returns valid integer" do
           subject.integer(:selected_account_id)
@@ -68,12 +113,12 @@ module Spine
       end
 
       context "with required constraint" do
-        it "has an error, if key is missing" do 
+        it "has an error, if key is missing" do
           subject.required(:beginning_of_week)
           expect(subject.errors?).to be
         end
 
-        it "has no errors if key exists" do 
+        it "has no errors if key exists" do
           subject.required(:some_timestamp)
           expect(subject.errors?).not_to be
         end

data/spine-parameters.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'spine-symbolize', "~> 0.1"
 
-  spec.add_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'bundler', "~> 1.10"
   spec.add_development_dependency 'rake', "~> 10.0"
-  spec.add_development_dependency 'rspec', "~> 3.2"
+  spec.add_development_dependency 'rspec', "~> 3"
   spec.add_development_dependency 'codeclimate-test-reporter', "~> 0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spine-parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - TOGGL LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spine-symbolize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -99,12 +99,16 @@ files:
 - lib/spine/parameters/action.rb
 - lib/spine/parameters/collection.rb
 - lib/spine/parameters/errors.rb
+- lib/spine/parameters/parsers/anything.rb
 - lib/spine/parameters/parsers/boolean.rb
 - lib/spine/parameters/parsers/integer.rb
+- lib/spine/parameters/parsers/list.rb
+- lib/spine/parameters/parsers/string.rb
 - lib/spine/parameters/parsers/timestamp.rb
 - lib/spine/parameters/syntax/boolean.rb
 - lib/spine/parameters/syntax/constraint.rb
 - lib/spine/parameters/syntax/integer.rb
+- lib/spine/parameters/syntax/list.rb
 - lib/spine/parameters/syntax/required.rb
 - lib/spine/parameters/syntax/timestamp.rb
 - lib/spine/parameters/version.rb
@@ -132,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Parameters validation and coversion.