keyword_init 1.4.0 → 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e8bc2a63aa1c7e7e6548c160bc51df2f23dfe1b
+  data.tar.gz: 57660108296d0af296eb473a9e318c63c10be197
+SHA512:
+  metadata.gz: 138568b1d59f117a0f15ebeb8d9fb336d8c48eca62766000dab45ab32cfb0c75746ea42b034e335dba5ff5e86c244e44c7294d73f54b84cd41bd8596b9366f14
+  data.tar.gz: 118fa2ee52b19fe221dc6b52576aeab6c15627bfe81af639f97ef0610cdef4d1f471d9e55ae703adcf3df24b6dc4fe660b2749905413362640d8fe939bd189c5

data/.gitignore

@@ -50,8 +50,10 @@ build/
 # 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
+.ruby-version
+.ruby-gemset
+
+/cc-test-reporter
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/.travis.yml

@@ -1,16 +1,26 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9d7b49edac4909edf2e78624b9c0589e15bf2573e5fc2c3d9e79f4994ffcc411
+
 language: ruby
 cache: bundler
 
 rvm:
-  - 2.1.1
+  - 2.5.0
+  - 2.4.3
+  - 2.3.6
+  - 2.2.9
+  - 2.1.10
   - 2.0.0
-  - 1.9.3
-
-addons:
-  code_climate:
-    repo_token: 9d7b49edac4909edf2e78624b9c0589e15bf2573e5fc2c3d9e79f4994ffcc411
 
-script: 'bundle exec rake spec'
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
 notifications:
   email:

data/Gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in keyword_init.gemspec
 gemspec
-gem 'codeclimate-test-reporter', :group => :test, :require => nil
+gem 'simplecov', group: :test, require: false

data/README.md

@@ -21,17 +21,6 @@ Or install it yourself as:
 
     $ gem install keyword_init
 
-## Changelog
-
-### v1.4.0 (renamed from v1.3.1)
-supports passing `nil` to both initializer and `_set_properties`
-
-### v1.3.0 
-the work is done by a private method `_set_properties` that expects a hash of attributes. This way the work can be performed on an existing instance by calling that private method.
-
-### 1.2.0 
-now works with private setters
-
 ## Usage
 
 You can have the basic keyword initialization in your class, by including the `KeywordInit` module in your class. This will include the `initialize` method in the class.
@@ -53,19 +42,60 @@ class TestKlass
   end
 end
 
-o = TestKlass.new attrib: 1, writeonly: 2, readonly: 3
+x = TestKlass.new attrib: 1, writeonly: 2, readonly: 3
 x.attrib # => 1
-
 # did not set the value because there is no `readonly=` method 
 x.readonly # => nil
 
 x.my_data # => {attrib: 1, writeonly: 2, readonly: nil}
 ```
 
+### Strict mode
+
+if we include `KeywordInit::Strict` instead of `KeywordInit` or `KeywordInit::Relaxed`, when the initializer receives a key with no matching setter, it will raise a `KeywordInit::KeyError` exception.
+
+```ruby
+class TestKlass
+  include KeywordInit
+  
+  attr_accessor :attrib
+  attr_writer :writeonly
+  attr_reader :readonly
+  
+  def my_data
+    {attrib: attrib, writeonly: writeonly, readonly: readonly}
+  end
+end
+
+good = TestKlass.new attrib: 1, writeonly: 2
+good.attrib # => 1
+good.my_data # => {attrib: 1, writeonly: 2, readonly: nil}
+
+bad =  TestKlass.new attrib: 1, writeonly: 2, readonly: 4
+  # => raises KeywordInit::KeyError
+ #
+bad2 =  TestKlass.new attrib: 1, writeonly: 2, unknown: 4
+  # => raises KeywordInit::KeyError 
+```
+
+
+## Changelog
+
+### v1.5.0
+supports **strict** mode.
+
+### v1.4.0 (renamed from v1.3.1)
+supports passing `nil` to both initializer and `_set_properties`
+
+### v1.3.0 
+the work is done by a private method `_set_properties` that expects a hash of attributes. This way the work can be performed on an existing instance by calling that private method.
+
+### 1.2.0 
+now works with private setters
+
 ## TODO
 
-1. "strict" to raise an error if an unrecognised option is called on method creation (keyword without a setter)
-2. "direct" integration with `fluent_accessors` ? 
+1. "direct" integration with `fluent_accessors` ? 
 
 ## Contributing
 

data/keyword_init.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'keyword_init/version'
 
 Gem::Specification.new do |spec|
-  spec.name                  = "keyword_init"
+  spec.name                  = 'keyword_init'
   spec.version               = KeywordInit::VERSION
-  spec.authors               = ["Eduardo Turiño"]
-  spec.email                 = ["eturino@eturino.com"]
+  spec.authors               = ['Eduardo Turiño']
+  spec.email                 = ['eturino@eturino.com']
   spec.summary               = %q{Gem that provides a keyword argument based initialize method to a class, executing the setter of all the recognised keywords.}
   # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage              = ""
-  spec.license               = "MIT"
+  spec.homepage              = ''
+  spec.license               = 'MIT'
   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.require_paths         = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec-nc"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency "pry-rescue"
-  spec.add_development_dependency "pry-stack_explorer"
-  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'pry-doc'
 
 end

data/lib/keyword_init.rb

@@ -1,16 +1,52 @@
 require "keyword_init/version"
 
 module KeywordInit
-  def initialize(properties = {})
-    _set_properties(properties || {})
+  def self.included(mod)
+    # if using the general KeywordInit module, use the Relaxed
+    mod.send(:include, Relaxed)
   end
 
-  private
-  def _set_properties(properties)
-    return unless properties
-    properties.each do |k, v|
-      normal_setter = "#{k}="
-      send normal_setter, v if respond_to? normal_setter, true
+  module Common
+    def initialize(properties = {})
+      _set_properties(properties || {})
     end
+
+    def self.normal_setter(k)
+      "#{k}="
+    end
+  end
+
+  module Relaxed
+    def self.included(mod)
+      mod.send(:include, Common)
+    end
+
+    private
+    def _set_properties(properties)
+      return unless properties
+      properties.each do |k, v|
+        normal_setter = Common.normal_setter(k)
+        send normal_setter, v if respond_to? normal_setter, true
+      end
+    end
+  end
+
+  module Strict
+    def self.included(mod)
+      mod.send(:include, Common)
+    end
+
+    private
+    def _set_properties(properties)
+      return unless properties
+      properties.each do |k, v|
+        normal_setter = Common.normal_setter(k)
+        raise KeyError.new("no setter recognised for #{k}") unless respond_to? normal_setter, true
+        send normal_setter, v
+      end
+    end
+  end
+
+  class KeyError < ::KeyError
   end
 end

data/lib/keyword_init/version.rb

@@ -1,3 +1,3 @@
 module KeywordInit
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/spec/keyword_init_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-RSpec.shared_examples "works" do
-  let(:expected_data) { {:attrib => 1, :writeonly => 2, :readonly => nil} }
-  let(:empty_data) { {:attrib => nil, :writeonly => nil, :readonly => nil} }
+RSpec.shared_examples "works in relaxed mode" do
+  let(:expected_data) { { :attrib => 1, :writeonly => 2, :readonly => nil } }
+  let(:empty_data) { { :attrib => nil, :writeonly => nil, :readonly => nil } }
 
   context '#initialize method' do
-    it 'accepts keyword parameters' do
+    it 'accepts keyword parameters (ignores read-only attributes or any given attribute with no setter)' do
       expect { described_class.new :attrib => 1, :writeonly => 2, :readonly => 3 }.not_to raise_error
     end
 
@@ -41,21 +41,104 @@ RSpec.shared_examples "works" do
   end
 end
 
-
 RSpec.describe KeywordInit do
-  class TestKlassWithPublicSetters
-    include KeywordInit
+  context 'normal behaviour (including KeywordInit)' do
+    class TestKlassWithPublicSetters
+      include KeywordInit
+
+      attr_accessor :attrib
+      attr_writer :writeonly
+      attr_reader :readonly
 
-    attr_accessor :attrib
-    attr_writer :writeonly
-    attr_reader :readonly
+      def my_data
+        { :attrib => @attrib, :writeonly => @writeonly, :readonly => @readonly }
+      end
+    end
 
-    def my_data
-      {:attrib => @attrib, :writeonly => @writeonly, :readonly => @readonly}
+    describe TestKlassWithPublicSetters do
+      it_behaves_like "works in relaxed mode"
     end
   end
 
-  describe TestKlassWithPublicSetters do
-    it_behaves_like "works"
+  context 'normal behaviour (including KeywordInit::Relaxed)' do
+    describe KeywordInit::Relaxed do
+      class TestKlassWithPublicSetters
+        include KeywordInit::Relaxed
+
+        attr_accessor :attrib
+        attr_writer :writeonly
+        attr_reader :readonly
+
+        def my_data
+          { :attrib => @attrib, :writeonly => @writeonly, :readonly => @readonly }
+        end
+      end
+
+      describe TestKlassWithPublicSetters do
+        it_behaves_like "works in relaxed mode"
+      end
+    end
+  end
+
+  context 'strict behaviour (KeywordInit::Strict)' do
+    describe KeywordInit::Strict do
+      class TestStrictKlassWithPublicSetters
+        include KeywordInit::Strict
+
+        attr_accessor :attrib
+        attr_writer :writeonly
+        attr_reader :readonly
+
+        def my_data
+          { :attrib => @attrib, :writeonly => @writeonly, :readonly => @readonly }
+        end
+      end
+
+      describe TestStrictKlassWithPublicSetters do
+        let(:expected_data) { { :attrib => 1, :writeonly => 2, :readonly => nil } }
+        let(:empty_data) { { :attrib => nil, :writeonly => nil, :readonly => nil } }
+
+        context '#initialize method' do
+          it 'accepts keyword parameters (ignores read-only attributes or any given attribute with no setter)' do
+            expect { described_class.new :attrib => 1, :writeonly => 2 }.not_to raise_error
+          end
+
+          it 'accepts keyword parameters (raises KeywordInit::KeyError if it receives read-only attributes or any given attribute with no setter)' do
+            expect { described_class.new :attrib => 1, :writeonly => 2, :readonly => 3 }.to raise_exception(KeywordInit::KeyError)
+            expect { described_class.new :attrib => 1, :writeonly => 2, :blaaah => 3 }.to raise_exception(KeywordInit::KeyError)
+          end
+
+          it 'executes the setter of each recognised keyword' do
+            expect_any_instance_of(described_class).to receive(:attrib=).with(1)
+            expect_any_instance_of(described_class).to receive(:writeonly=).with(2)
+            described_class.new :attrib => 1, :writeonly => 2
+          end
+
+          it 'sets the correct values' do
+            a = described_class.new :attrib => 1, :writeonly => 2
+            expect(a.my_data).to eq expected_data
+          end
+
+          it 'does nothing if nil passed' do
+            a = described_class.new nil
+            expect(a.my_data).to eq empty_data
+          end
+        end
+
+        context '#_set_properties method (private)' do
+          subject { described_class.new }
+
+          it 'sets the correct values (after creation) in the subject, in the same way of the initialize method' do
+            subject.send :_set_properties, :attrib => 1, :writeonly => 2
+            expect(subject.my_data).to eq expected_data
+          end
+
+          it 'does nothing if nil passed' do
+            subject.send :_set_properties, nil
+            expect(subject.my_data).to eq empty_data
+          end
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'bundler/setup'
 Bundler.setup
 
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'pry'
 require 'keyword_init'

metadata

@@ -1,158 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: keyword_init
 version: !ruby/object:Gem::Version
-  version: 1.4.0
-  prerelease: 
+  version: 1.5.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-rescue
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -162,9 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -177,36 +158,28 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3451831627487267256
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3451831627487267256
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem that provides a keyword argument based initialize method to a class,
   executing the setter of all the recognised keywords.
 test_files:
 - spec/keyword_init_spec.rb
 - spec/spec_helper.rb
-has_rdoc: