tainbox 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c180884b0471d64ec257abcb626c43cd59a79fe8
-  data.tar.gz: fcfd7c4fd5e0ab7f3f0ada8b04409363e55032a9
+  metadata.gz: f97ba89e290c39aa627d72acdd087f15d8425535
+  data.tar.gz: 4187cef87c10dea2fc9be5cf80c26f0bc936ff40
 SHA512:
-  metadata.gz: a0f2941c17de11c3e083d3303ae87602d6f542b7ebfb7d586058278789c4e6c3e45f192b0193d6ecdbb23f24556e37052dab07e6d665bdb33b6a88602731b7bc
-  data.tar.gz: 77c030002c12e6f0e3aa7e1abe0b3135bded6d9d39cdf0d4a808e56decb99cc40180dfa44cddbff9b686f169c2ca52ef7826742d1b4560c5615c5946291ef023
+  metadata.gz: d445dad53f0615cd342ec4adb1bd80885328e68308d933f13c7993066fd168255d7703c4540354b02f698051082ff2a665649d36cfeea4c0062ca1b8aee7bc57
+  data.tar.gz: 103da0ff13be9e547dfa04f40a63d8507de78bbcde8e0a3a63e43273a265b24f6e233e555ba68b00fcd24db379866e0b8bf80039fa44d4c09dd3c2b55c527404

data/README.md

@@ -0,0 +1,95 @@
+# Tainbox
+
+Tainbox is a utility gem that can be used to inject attributes into ruby objects. It is similar to <a href="https://github.com/solnic/virtus">Virtus</a>, but works a bit more sensibly (hopefully) and throws in some additional features.
+
+## But we already have attr_accessor!
+
+Consider this code:
+
+``` ruby
+class Person
+  include Tainbox
+  attribute :name, default: -> { "person_#{age}" }
+  attribute :age, Integer, default: 20
+end
+```
+
+Here are the basic features you get:
+
+``` ruby
+person = Person.new(name: 'John', age: '30')
+person.attributes # => { :name => "John", :age => 30 }
+person.age = 50
+person.age # => 50
+person.attributes = {}
+person.attributes # => { :name => "person_20", :age => 20 }
+```
+
+## Additional features
+
+### Method overrides
+
+Tainbox attributes can be freely overriden:
+
+``` ruby
+def name
+  super.strip
+end
+```
+
+``` ruby
+def name=(value)
+  super('Stupid example')
+end
+```
+
+### #attribute_provided?
+
+Attribute is considered provided if its setter was explicitly invoked via a setter, `.new`, or `#attributes=` or it has a default value.
+
+``` ruby
+class Person
+  include Tainbox
+  attribute :name, default: 'John'
+  attribute :age
+end
+
+person = Person.new
+person.attribute_provided?(:age) # => false
+person.attribute_provided?(:name) # => true
+```
+
+### readonly and writeonly attributes
+
+Speaks for itself:
+
+``` ruby
+class Person
+  include Tainbox
+  attribute :name, writeonly: true
+  attribute :age, readonly: true
+end
+```
+
+### Built-in type converters
+
+All converters return nil if conversion could not be made.
+
+- Integer
+- Float
+- String
+- Symbol
+- Time
+- Boolean
+
+### Custom type converters
+
+You can define a custom type converter like so:
+
+``` ruby
+# value and options are automatically available in scope
+Tainbox.define_converter(MyType) do
+  # Do whatever you want with value
+  options[:strict] ? MyType.convert!(value) : MyType.convert(value)
+end
+```

data/lib/tainbox/version.rb

@@ -1,3 +1,3 @@
 module Tainbox
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/tainbox.gemspec

@@ -8,8 +8,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dmitry Gubitskiy']
   spec.email         = ['d.gubitskiy@gmail.com']
 
-  # TODO Proper summary
-  spec.summary       = 'Tainbox summary'
+  spec.summary       = 'Tainbox is a utility gem that can be used to inject attributes '\
+                       'into ruby objects. It is similar to Virtus, but works a bit more '\
+                       'sensibly (hopefully) and throws in some additional features'
   spec.homepage      = 'https://github.com/enthrops/tainbox'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tainbox
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dmitry Gubitskiy
@@ -77,6 +77,7 @@ files:
 - ".rspec"
 - Gemfile
 - LICENSE.txt
+- README.md
 - bin/console
 - lib/tainbox.rb
 - lib/tainbox/attribute_definer.rb
@@ -110,6 +111,8 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Tainbox summary
+summary: Tainbox is a utility gem that can be used to inject attributes into ruby
+  objects. It is similar to Virtus, but works a bit more sensibly (hopefully) and
+  throws in some additional features
 test_files: []
 has_rdoc: