spine-parameters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd9ed99df2da99181265828c269cfecc00c05fae
+  data.tar.gz: 214f867131978a0d58f1cd1a699d7b71a3652fdf
+SHA512:
+  metadata.gz: c29db06623b7408446f3820bfac76ec0536b4d24c3a5d4aef5b61218e9581f47f58aa1de0e88e18108ac69ec0d120902bfd0d69f6c5d0a0aff7ef2b94ecbe296
+  data.tar.gz: ef7fb9ed94c8cce1a475a110cc4fe831230cc4d315655d33e75a60b4336b454f02180af08c658aaba510abbc628a259c1b5d1cb0429215cf96a436132834f894

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require config/default

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spine-parameters.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    spine-parameters (0.1.0)
+      spine-symbolize (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    spine-symbolize (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  spine-parameters!

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the TOGGL LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,34 @@
+# Spine::Parameters
+
+[![Gem Version](https://badge.fury.io/rb/spine-parameters.svg)](http://badge.fury.io/rb/spine-parameters)
+[![Dependency Status](https://gemnasium.com/rspine/parameters.svg)](https://gemnasium.com/rspine/parameters)
+[![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)
+
+Validates and converts parameters. Also it converts all keys to symbols.
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-parameters'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-parameters`.
+
+## Usage
+
+```ruby
+parameters = Spine::Parameters::Collection.new(parameters_containing_hash)
+parameters.required(:name)
+  .integer(:id)
+  .timestamp(:since)
+
+parameters.errors? # Checks if there is any parsing error.
+parameters.errors
+# => { id: ['invalid number'] }
+
+parameters[:since]
+# => <DateTime: 2014-01-01T12:00:00+00:00>
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spine/parameters/collection.rb

@@ -0,0 +1,38 @@
+require 'spine/symbolize'
+
+module Spine
+  module Parameters
+    class Collection
+      include Syntax::Timestamp
+      include Syntax::Integer
+      include Syntax::Boolean
+      include Syntax::Constraint
+      include Syntax::Required
+      include Errors
+
+      attr_reader :raw, :values
+
+      def initialize(raw)
+        @raw = raw
+        @values = {}
+      end
+
+      def [](key)
+        values.fetch(key.to_sym) { symbolized[key.to_sym] }
+      end
+
+      def symbolized
+        @symbolized ||= Symbolize.keys(raw)
+      end
+
+      private
+
+      def parse(name, parser, &block)
+        key = name.to_sym
+        values[key] = parser.parse(key, symbolized[key]) if symbolized[key]
+        values[key] ||= block.call if block_given?
+        self
+      end
+    end
+  end
+end

data/lib/spine/parameters/errors.rb

@@ -0,0 +1,17 @@
+module Spine
+  module Parameters
+    module Errors
+      def errors
+        @errors ||= {}
+      end
+
+      def add_error(field, message)
+        errors[field] = [message]
+      end
+
+      def errors?
+        !errors.empty?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Spine
+  module Parameters
+    module Parsers
+      module Boolean
+        extend self
+
+        def parse(name, value)
+          return nil unless value
+          return true if value == true || value =~ (/^(true|t|yes|y|1)$/i)
+          return false if value == false || value.empty? || value =~ (/^(false|f|no|n|0)$/i)
+
+          raise ArgumentError.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Spine
+  module Parameters
+    module Parsers
+      module Integer
+        extend self
+
+        def parse(name, value)
+          return nil unless value
+
+          Integer(value.to_s, 10)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spine
+  module Parameters
+    module Parsers
+      module Timestamp
+        extend self
+
+        def parse(name, value)
+          return nil unless value
+          return value if value.is_a?(Date)
+
+          DateTime.iso8601(value.to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spine
+  module Parameters
+    module Syntax
+      module Boolean
+        def boolean(name, options = {}, &block)
+          parse(name, Parsers::Boolean, &block)
+        rescue ArgumentError
+          add_error(name, 'is invalid truth value.')
+          self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spine
+  module Parameters
+    module Syntax
+      module Constraint
+        def constraint(name, message, &block)
+          add_error(name, message) if block.call(symbolized[name])
+          self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spine
+  module Parameters
+    module Syntax
+      module Integer
+        def integer(name, options = {}, &block)
+          parse(name, Parsers::Integer, &block)
+        rescue ArgumentError
+          add_error(name, 'is invalid number.')
+          self
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spine
+  module Parameters
+    module Syntax
+      module Required
+        def required(name)
+          constraint(name.to_sym, 'is required') { |value| value.nil? }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spine
+  module Parameters
+    module Syntax
+      module Timestamp
+        def timestamp(name, options = {}, &block)
+          parse(name, Parsers::Timestamp, &block)
+        rescue ArgumentError
+          add_error(name, 'is invalid date.')
+          self
+        end
+      end
+    end
+  end
+end

data/lib/spine/parameters/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Parameters
+    VERSION = "0.1.0"
+  end
+end

data/lib/spine/parameters.rb

@@ -0,0 +1,20 @@
+module Spine
+  module Parameters
+    autoload :Errors, 'spine/parameters/errors'
+    autoload :Collection, 'spine/parameters/collection'
+
+    module Syntax
+      autoload :Constraint, 'spine/parameters/syntax/constraint'
+      autoload :Integer, 'spine/parameters/syntax/integer'
+      autoload :Timestamp, 'spine/parameters/syntax/timestamp'
+      autoload :Boolean, 'spine/parameters/syntax/boolean'
+      autoload :Required, 'spine/parameters/syntax/required'
+    end
+
+    module Parsers
+      autoload :Integer, 'spine/parameters/parsers/integer'
+      autoload :Timestamp, 'spine/parameters/parsers/timestamp'
+      autoload :Boolean, 'spine/parameters/parsers/boolean'
+    end
+  end
+end

data/spec/config/default.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end

data/spec/spine/parameters/parameters_spec.rb

@@ -0,0 +1,83 @@
+require 'ostruct'
+require 'date'
+require 'spine/parameters'
+
+module Spine
+  module Parameters
+    describe Parameters do
+      subject { Parameters::Collection.new(parameters) }
+      let(:parameters){
+        {
+          "selected_account_id"=>"1",
+          "some_timestamp" => "2015-01-12T10:42:36+02:00",
+          "google_login" => "true"
+        }
+      }
+
+      it "symbolizes keys" do
+        expect(subject[:selected_account_id]).to be
+        expect(subject[:some_timestamp]).to be
+      end
+
+      context "when parsing integer" do
+        it "returns valid integer" do
+          subject.integer(:selected_account_id)
+          expect(subject[:selected_account_id]).to eq(1)
+        end
+
+        it "has errors if integer not parsed" do
+          subject.integer(:some_timestamp)
+          expect(subject.errors?).to be
+        end
+      end
+
+      context "when parsing timestamp" do
+        it "parses timestamp" do
+          subject.timestamp(:some_timestamp)
+          expect(subject[:some_timestamp].is_a?(DateTime)).to be
+          expect(subject.errors?).not_to be
+        end
+
+        it "has errors if timestamp not parsed" do
+          subject.timestamp(:selected_account_id)
+          expect(subject.errors?).to be
+        end
+      end
+
+      context "when parsing boolean" do
+        it "returns valid boolean value" do
+          subject.boolean(:google_login)
+          expect(subject[:google_login]).to eq(true)
+        end
+
+        it "has errors if not parsed" do
+          subject.boolean(:some_timestamp)
+          expect(subject.errors?).to be
+        end
+      end
+
+      it "initializes value if block present" do
+        date = Date.today.prev_month(6)
+        subject.timestamp(:since) { date }
+        expect(subject[:since]).to eq(date)
+      end
+
+      it "doesn't add key to values, if it's not present in raw data" do
+        subject.integer(:beginning_of_week)
+        expect(subject.values).to eq({})
+      end
+
+      context "with required constraint" 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 
+          subject.required(:some_timestamp)
+          expect(subject.errors?).not_to be
+        end
+      end
+    end
+  end
+end

data/spine-parameters.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/parameters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-parameters"
+  spec.version       = Spine::Parameters::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = 'Parameters validation and coversion.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/parameters'
+  spec.license       = 'BSD-3-Clause'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'spine-symbolize', "~> 0.1"
+
+  spec.add_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: spine-parameters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spine-symbolize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine/parameters.rb
+- lib/spine/parameters/collection.rb
+- lib/spine/parameters/errors.rb
+- lib/spine/parameters/parsers/boolean.rb
+- lib/spine/parameters/parsers/integer.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/required.rb
+- lib/spine/parameters/syntax/timestamp.rb
+- lib/spine/parameters/version.rb
+- spec/config/default.rb
+- spec/spine/parameters/parameters_spec.rb
+- spine-parameters.gemspec
+homepage: https://github.com/rspine/parameters
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Parameters validation and coversion.
+test_files:
+- spec/config/default.rb
+- spec/spine/parameters/parameters_spec.rb