eigindir 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a04b87646bc1711b3906a320357ff5c3a0ac6329
+  data.tar.gz: e1e65a6867902d0a8b6ad1a6a1c80bd53a1e9db9
+SHA512:
+  metadata.gz: 0a815b9c785c79e92b18add69df7bccd7f323391daf508b0e5ffdb24678256e1fb16b3ca426b2e289713660f41874bee71f88f788137f0a4da04ea7d2c0f549a
+  data.tar.gz: b519e53fcab8f5375bd9f508400af912b63ba5f534cd838ef67c49c258cb73e06ebea0a2ee4e59ba4e6e1aaa82db4bb718b0f144303f7356cc6e18d68700f0a5

data/.coveralls.yml

@@ -0,0 +1,2 @@
+---
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.lock
+.bundle/
+.yardoc/
+coverage/
+doc/
+log/
+pkg/
+tmp/

data/.metrics

@@ -0,0 +1,9 @@
+# Settings for metric_fu and its packages are collected in the `config/metrics`
+# and loaded by the Hexx::Suit::Metrics::MetricFu.
+
+begin
+  require "hexx-suit"
+  Hexx::Suit::Metrics::MetricFu.load
+rescue LoadError
+  puts "The 'hexx-suit' gem is not installed"
+end

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+---
+inherit_from: "./config/metrics/rubocop.yml"

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language:     ruby
+bundler_args: --without metrics
+cache:        bundler
+script:       rake test:coverage:run
+rvm:
+  - '2.1'
+  - '2.2'
+  - ruby-head

data/.yardopts

@@ -0,0 +1,3 @@
+--asset LICENSE
+--exclude lib/eigindir/version.rb
+--output doc/api

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :metrics do
+  gem "hexx-suit", "~> 2.2" if RUBY_ENGINE == "ruby"
+end

data/Guardfile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+guard :rspec, cmd: "bundle exec rspec" do
+
+  watch(%r{^spec/tests/.+_spec\.rb$})
+
+  watch(%r{^lib/(.+)\.rb$}) do |m|
+    "spec/tests/#{ m[1] }_spec.rb"
+  end
+
+  watch(%r{^lib/\w+\.rb$})     { "spec" }
+  watch("spec/spec_helper.rb") { "spec" }
+
+end # guard :rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015 Andrew Kozin (nepalez), andrew.kozin@gmail.com
+
+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,342 @@
+Eigindir
+========
+
+[![Gem Version](https://img.shields.io/gem/v/eigindir.svg?style=flat)][gem]
+[![Build Status](https://img.shields.io/travis/nepalez/eigindir/master.svg?style=flat)][travis]
+[![Dependency Status](https://img.shields.io/gemnasium/nepalez/eigindir.svg?style=flat)][gemnasium]
+[![Code Climate](https://img.shields.io/codeclimate/github/nepalez/eigindir.svg?style=flat)][codeclimate]
+[![Coverage](https://img.shields.io/coveralls/nepalez/eigindir.svg?style=flat)][coveralls]
+[![Inline docs](http://inch-ci.org/github/nepalez/eigindir.svg)][inch]
+
+[codeclimate]: https://codeclimate.com/github/nepalez/eigindir
+[coveralls]: https://coveralls.io/r/nepalez/eigindir
+[gem]: https://rubygems.org/gems/eigindir
+[gemnasium]: https://gemnasium.com/nepalez/eigindir
+[travis]: https://travis-ci.org/nepalez/eigindir
+[inch]: https://inch-ci.org/github/nepalez/eigindir
+
+Coercible PORO attributes.
+
+Synopsis
+--------
+
+This is a tiny [virtus]-inspired library
+for PORO attributes' definition and coersion.
+
+Like [virtus] it declares attributes, and coerces their values.
+Unlike [virtus] it uses different coersion mechanism, and does nothing else.
+
+[virtus]: https://github.com/solnic/virtus
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute(
+    :bar,
+    writer: ->(v) { v.to_i + 1 },
+    reader: ->(v) { v.to_s     }
+  )
+end
+
+foo = Foo.new
+
+# the setter coerced given value:
+foo.bar = "10"
+foo.instance_eval "@bar" # => 11
+# the getter coerced stored value:
+foo.instance_eval # => "11"
+
+# attributes getter and setter are defined as well:
+foo.attributes = { "bar" => 5 }
+foo.attributes # => { bar: "6" }
+```
+
+The module doesn't define the initializer.
+You're free to define in a following way:
+
+```ruby
+class Foo
+  include Eigindir
+
+  def initializer(**options)
+    self.attributes = options
+  end
+end
+```
+
+Details
+-------
+
+### Base Use
+
+`attribute`, `attribute_reader` and `attribute_writer` are like
+`attr_accessor`, `attr_reader` and `attr_writer`:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar
+  attribute_reader :baz
+  attribute_writer :qux
+end
+
+foo = Foo.new
+
+foo.bar = 1
+foo.bar # => 1
+
+foo.baz = 1 # <NoMethodError>
+foo.baz # => nil
+
+foo.qux = 1
+foo.instance_eval "@qux" # => 1
+foo.qux # <NoMethodError>
+```
+
+### Attributes Declaration
+
+The `attributes` and `attributes=` ignore all keys not declared as `attribute`.
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar
+  attr_accessor :baz
+end
+
+foo = Foo.new
+foo.attributes = { bar: 1, baz: 2 }
+foo.bar # => 1
+foo.baz # => nil
+
+foo.baz = 2
+foo.baz # => 2
+foo.attributes # => { bar: 1 }
+```
+
+The methods ignore attributes that has no getters or setters correspondingly:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute_reader :bar
+  attribute_writer :baz
+end
+
+foo = Foo.new
+foo.attributes = { bar: 1, baz: 1 }
+
+# baz has no getter,
+# bar value is not assigned because it has no setter:
+foo.attributes = { bar: nil }
+```
+
+The `attributes=` accepts hash with any stringified keys and symbolizes them:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar
+  attribute :baz
+end
+
+foo = Foo.new
+foo.attributes = { bar: "1", "bar" => 2 }
+# The setter symbolizes keys to :bar and uses last value:
+foo.attributes # => { bar: 2 }
+```
+
+### Base Coersion
+
+All class methods: `attribute`, `attribute_reader` and `attribute_writer`
+accepts the `:coerce` key:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar, coerce: ->(val) { val.to_i + 1 }
+end
+```
+
+The setter coerces given value:
+
+```ruby
+foo = Foo.new
+
+foo.bar = "1"
+foo.instance_eval "@bar" # => 2
+```
+
+The getter coerces stored variable:
+
+```ruby
+foo.instance_eval "@bar" # => 2
+foo.bar # => 3
+```
+
+A coercer can be set either as proc or lambda, or by instance method name.
+The following declarations are equivalent:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar, coerce: ->(value) { value.to_s }
+  attribute :bar, coerce: lambda { |value| value.to_s }
+  attribute :bar, coerce: proc { |value| value.to_s }
+  attribute :bar, coerce: :coercer
+  attribute :bar, coerce: "coercer"
+
+  private
+
+  def coercer(value)
+    value.to_s
+  end
+end
+```
+
+### Separate Coersion
+
+The `attribute` class method also takes `:reader` and `:writer`.
+Every option sets its own coersion for the corresponding direction:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute(
+    :bar,
+    writer: ->(val) { val.to_i + 1 }
+    reader: ->(val) { val.to_s     }
+  )
+end
+
+foo = Foo.new
+
+# The setter uses the :writer coercer:
+foo.bar = "10"
+foo.instance_eval "@bar" # => 11
+
+# The getter uses the :reader coercer:
+foo.bar # => "11"
+```
+
+### Coersion of nil
+
+Because +nil+ stands for pure nothing, it is not coerced by default:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar, coerce: &:to_s
+end
+
+foo = Foo.new
+foo.bar = nil
+foo.instance_eval "@bar" # => nil
+foo.bar # => nil
+```
+
+Use `strict: true` option to coerce `nil` as well:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :baz, coerce: &:to_s, strict: true
+end
+
+foo = Foo.new
+foo.bar = nil
+foo.instance_eval "@bar" # => ""
+foo.bar # => ""
+```
+
+This can be used to set default values explicitly either by getter or setter:
+
+```ruby
+class Foo
+  include Eigindir
+
+  attribute :bar, reader: proc { |val| val || 1 }, strict: true
+  attribute :baz, writer: proc { |val| val || 1 }, strict: true
+end
+
+foo = Foo.new
+
+# The getter's default is pretty virtual:
+foo.bar = nil
+foo.instance_eval "@bar" # => nil
+foo.bar # => 1
+
+# While the setter's is persistent:
+foo.baz = nil
+foo.instance_eval "@baz" # => 1
+foo.baz # => 1
+```
+
+Credits
+-------
+
+Many thanks to Icelandic for
+[the name of the module](https://translate.google.ru/?hl=en#is/en/eigindir).
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem "eigindir"
+```
+
+Then execute:
+
+```
+bundle
+```
+
+Or add it manually:
+
+```
+gem install eigindir
+```
+
+Compatibility
+-------------
+
+Tested under [MRI rubies 2.1+](.travis.yml) only.
+
+It uses [Ruby 2.1+ refinements] that aren't yet supported by Rubinius and JRuby.
+
+Uses [RSpec] 3.0+ for testing and [hexx-suit] for dev/test tools collection.
+
+[Ruby 2.1+ refinements]: http://ruby-doc.org/core-2.1.1/doc/syntax/refinements_rdoc.html
+[RSpec]: http://rspec.org
+[hexx-suit]: https://github.com/nepalez/hexx-suit
+
+Contributing
+------------
+
+* Fork the project.
+* Read the [STYLEGUIDE](config/metrics/STYLEGUIDE).
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or version
+  (if you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+License
+-------
+
+See the [MIT LICENSE](LICENSE).