keyword_init 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 018ffb118d8fdf0ffb546b8521f8f6b27e34c87e
+  data.tar.gz: 73f5d005d2a422553405a0cc882520e5633592d2
+SHA512:
+  metadata.gz: 52398c7af6ce1dbca0588c7879af0bb7af5b8e1c60206f55b3d80a7118d5c951c44553c901df304553ea0138369a603eb5269eda2d74be07c4a5b21e84591bba
+  data.tar.gz: fc00638b5347138a327e17c8a160a108c25a9828295aa42cde62e82c2c06ca1208e84e9023382d4653d88980a2eafdf54aa2ce0be96930755da8ad927117212d

data/.gitignore

@@ -0,0 +1,57 @@
+.idea
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.1
+
+addons:
+  code_climate:
+    repo_token: 9d7b49edac4909edf2e78624b9c0589e15bf2573e5fc2c3d9e79f4994ffcc411
+
+script: 'bundle exec rake spec'
+
+notifications:
+  email:
+    recipients:
+      - eturino@eturino.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keyword_init.gemspec
+gemspec
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eduardo Turiño
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# KeywordInit
+
+Gem that provides a keyword argument based `initialize` method to a class, executing the setter of all the recognised keywords.
+
+[![Gem Version](https://badge.fury.io/rb/keyword_init.svg)](http://badge.fury.io/rb/keyword_init)
+[![Build Status](https://travis-ci.org/eturino/keyword_init.svg?branch=master)](https://travis-ci.org/eturino/keyword_init)
+[![Code Climate](https://codeclimate.com/github/eturino/keyword_init.png)](https://codeclimate.com/github/eturino/keyword_init)
+[![Code Climate Coverage](https://codeclimate.com/github/eturino/keyword_init/coverage.png)](https://codeclimate.com/github/eturino/keyword_init)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keyword_init'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyword_init
+
+## 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.
+
+For each keyword that the `initialize` method receives, it will execute the setter if that method exists (it will look for a method called `keyword_name=`). 
+
+It will ignore all keywords that don't have a valid setter.
+
+```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
+
+o = TestKlass.new attrib: 1, writeonly: 2, readonly: 3
+x.attrib # => 1
+
+# did not set the value because there are no `readonly=` method 
+x.readonly # => nil
+
+x.my_data # => {attrib: 1, writeonly: 2, readonly: nil}
+```
+
+## 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` ? 
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/keyword_init/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec
+

data/keyword_init.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyword_init/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyword_init"
+  spec.version       = KeywordInit::VERSION
+  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.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_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/version.rb

@@ -0,0 +1,3 @@
+module KeywordInit
+  VERSION = '1.0.0'
+end

data/lib/keyword_init.rb

@@ -0,0 +1,10 @@
+require "keyword_init/version"
+
+module KeywordInit
+  def initialize(** properties)
+    properties.each do |k, v|
+      normal_setter = "#{k}="
+      send normal_setter, v if respond_to? normal_setter
+    end
+  end
+end

data/spec/keyword_init_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe KeywordInit do
+  class TestKlass
+    include KeywordInit
+
+    attr_accessor :attrib
+    attr_writer :writeonly
+    attr_reader :readonly
+
+    def my_data
+      {attrib: attrib, writeonly: writeonly, readonly: readonly}
+    end
+  end
+
+  context 'initialize method' do
+    it 'accepts keyword parameters' do
+      expect { TestKlass.new attrib: 1, writeonly: 2, readonly: 3 }.not_to raise_error
+    end
+
+    it 'executes the setter of each recognised keyword' do
+      expect_any_instance_of(TestKlass).to receive(:attrib=).with(1)
+      expect_any_instance_of(TestKlass).to receive(:writeonly=).with(2)
+      TestKlass.new attrib: 1, writeonly: 2, readonly: 3
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'pry'
+require 'keyword_init'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: keyword_init
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eduardo Turiño
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eturino@eturino.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keyword_init.gemspec
+- lib/keyword_init.rb
+- lib/keyword_init/version.rb
+- spec/keyword_init_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+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: