attr_init 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f8d8370936afc741606695fc33b963636f01dfe
+  data.tar.gz: 8174381ab0003632aa7feb366a778d2d6be342dd
+SHA512:
+  metadata.gz: 6c8ebc6254c78d3d872cce690b20bb5ac571dd4644385a39406aebffa001546cfa8ac03658bf9618d58c1ceab339b452cbe243c5433e01f973e8fd510e8e4c78
+  data.tar.gz: 51690168d15f9179dc8ee5d6087784d6743521b1b13f5c8af27d9c535e127cb7f44e3713a7b987f0539536fea77f5b4a9e7d89d7cf5f48335b816fc75e9d51ec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+
+rvm:
+  - 2.1.0
+
+gemfile:
+  - Gemfile
+
+cache: bundler
+
+env:
+  matrix:
+    - TEST_SUITE="spec"
+
+before_script: "bundle update"
+
+script:
+  - bundle exec rake $TEST_SUITE
+
+notifications:
+  email: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 johnmcconnell
+
+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,100 @@
+# AttrInit
+
+[![Coverage
+Status](https://coveralls.io/repos/johnmcconnell/attr_init/badge.png)](https://coveralls.io/r/johnmcconnell/attr_init)
+
+So ruby has `Struct` but I never use it because:
+  1. I have to extend the class with `Struct`
+  2. It makes your instance_variables public
+  3. It does not use hash initialization
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attr_init'
+```
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_init
+
+## Usage
+
+### Initializer
+
+```ruby
+class Foo
+  attr_init :a, :b
+end
+
+f = Foo.new(a: 0, b: 1)
+=> #<Foo:0xb811601c @a=0, @b=1>
+
+f.a
+NoMethodError: undefined method: a' for #<Bar:0xb811601c @a=0, @b=1>
+```
+If you want to you can override it:
+
+```ruby
+
+class Foo
+  attr_init :a, :b
+  def initialize(params, opt=nil)
+    if opt.nil?
+      do_other_initializer
+    else
+      attr_init(params)
+    end
+  end
+end
+
+```
+
+### Initializer with readers
+
+```ruby
+class Bar
+  reader_struct :a, :b
+end
+
+b = Bar.new(a: 0, b: 1)
+=> #<Bar:0xaf11321c @a=0, @b=1>
+
+b.a
+=> 0
+
+b.a = 2
+NoMethodError: undefined method: a=' for #<Bar:0xb931e250 @a=0, @b=1>
+```
+
+### Initializer with accessors
+
+```ruby
+class Dah
+  accessor_struct :a, :b
+end
+
+d = Dah.new(a: 0, b: 1)
+=> #<Dah:0x81ad601c @a=0, @b=1>
+
+d.a
+=> 0
+
+d.a = 2
+=> 2
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[johnmcconnell]/attr_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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+RSpec::Core::RakeTask.new(:spec)
+
+

data/attr_init.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_init/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_init"
+  spec.version       = AttrInit::VERSION
+  spec.authors       = ["johnmcconnell"]
+  spec.email         = ["johnnyillinois@gmail.com"]
+  spec.summary       = %q{Reader structs for ruby finally!.}
+  spec.description   = %q{Reader structs for ruby finally!.}
+  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 "simplecov", "~> 0.8.0"
+  spec.add_development_dependency "coveralls", "~> 0.7.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/attr_init/version.rb

@@ -0,0 +1,3 @@
+module AttrInit
+  VERSION = "0.0.1"
+end

data/lib/attr_init.rb

@@ -0,0 +1,38 @@
+require "attr_init/version"
+
+def attr_init(*attrs)
+  define_method(:attr_init) do |params|
+    attrs.each do |a|
+      instance_variable_set "@#{a}", params[a]
+    end
+  end
+
+  protected :attr_init
+
+  define_method(:initialize) do |params|
+    attr_init(params)
+  end
+end
+
+def attr_hash(*attrs)
+  define_method(:to_h) do
+    attrs.each_with_object({}) do |attr, hash|
+      hash[attr] = send(attr)
+    end
+  end
+end
+
+def reader_struct(*attrs)
+  attr_reader *attrs
+  attr_init *attrs
+  attr_hash *attrs
+end
+
+def accessor_struct(*attrs)
+  attr_accessor *attrs
+  attr_init *attrs
+  attr_hash *attrs
+end
+
+module AttrInit
+end

data/spec/attr_init_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'attr_init'
+
+describe AttrInit do
+  let(:symbols) do
+    [:a, :b, :c]
+  end
+
+  let(:hash_params) do
+    Hash[symbols.each_with_index.to_a]
+  end
+
+  let(:reader_struct) do
+    class Foo
+      reader_struct :a, :b, :c
+    end
+    Foo
+  end
+
+  let(:accessor_struct) do
+    class Bar
+      accessor_struct :a, :b, :c
+    end
+    Bar
+  end
+
+  describe '::new' do
+    context 'reader_struct' do
+      it 'initializes readers with hash initializer' do
+        object = reader_struct.new(hash_params)
+
+        expect(object.a).to eq 0
+        expect(object.b).to eq 1
+        expect(object.c).to eq 2
+
+        expect { object.a = 3 }.to raise_error
+      end
+    end
+
+    context 'accessor_struct' do
+      it 'initializes accessor with hash initializer' do
+        object = accessor_struct.new(hash_params)
+
+        expect(object.a).to eq 0
+        expect(object.b).to eq 1
+        expect(object.c).to eq 2
+
+        object.a = 'hello'
+
+        expect(object.a).to eq 'hello'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'attr_init'
+require 'vcr'
+require 'coveralls'
+
+Coveralls.wear!
+
+class SpecHelper
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: attr_init
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- johnmcconnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Reader structs for ruby finally!.
+email:
+- johnnyillinois@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_init.gemspec
+- lib/attr_init.rb
+- lib/attr_init/version.rb
+- spec/attr_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: Reader structs for ruby finally!.
+test_files:
+- spec/attr_init_spec.rb
+- spec/spec_helper.rb