liner 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1031b1dc95208b1a8692204114af88b6e46ee907
-  data.tar.gz: f4a3cb0860e01d58d748bf0b000ef1e38b8a6290
+  metadata.gz: 53f068a96a64299ca295a0c1821a5232a4ec2618
+  data.tar.gz: 459fd2b8e24e184a5437744fa1ae3701c384d609
 SHA512:
-  metadata.gz: 0cd932e7fddb88187281890814b89af03ef3c01fc0bcc635fa3f6f2d3614c624776a74f2ef7308c9cee013d004b7df82214f4483931921871af53ba571e9257f
-  data.tar.gz: 7722ba0e233b9ad646ec73be8fe5192c154d3442be4ff2f01138912f1648f96cdbd3004caec1851cc19ba7edabcd0bbe5d52bdbd3e4551528e0c45c8627832c5
+  metadata.gz: 98f7de6a0c3580a6dd7c8774aa7b427b7819c30a28ad1dce9fdfd362fd3c6a9742df59f2c9a0b64508e943a802a3fa422c3f442c6529827d7acf5dab9e943bd1
+  data.tar.gz: 7d8e902c6662b26f751bee45f120855c21e3a300a66532fe536d4be439f5063745a352691f97788cd0461086a88bba3b6ff269327354d75c0761b381cf29abf3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/README.md

@@ -1,27 +1,40 @@
 # Liner
+[![Build Status](https://travis-ci.org/joshwlewis/liner.png?branch=master)](https://travis-ci.org/joshwlewis/liner)
+[![Coverage Status](https://coveralls.io/repos/joshwlewis/liner/badge.png?branch=master)](https://coveralls.io/r/joshwlewis/liner?branch=master)
+[![Gem Version](https://badge.fury.io/rb/liner.png)](http://badge.fury.io/rb/liner)
+[![Dependency Status](https://gemnasium.com/joshwlewis/liner.png)](https://gemnasium.com/joshwlewis/liner)
+[![Code Climate](https://codeclimate.com/github/joshwlewis/liner.png)](https://codeclimate.com/github/joshwlewis/liner)
 
-Lay a liner for your Ruby classes. Liner is designed to enhance simple classes
-with some common idioms.
+Lay a liner for your Ruby classes. Liner is a lightweight library designed to 
+enhance simple classes with some conveniences and idioms while staying out of 
+your way.
 
 ## Usage
 
+### Setup
+
 You can setup a Liner based class in any of these equivalent ways:
 
 ```ruby
 Engine = Liner.new(:layout, :fuel)
 ```
+
 ```ruby
 class Engine < Liner.new(:layout, :fuel)
 end
 ```
+
 ```ruby
 class Engine
   liner :layout, :fuel
 end
 ```
 
+### Initialization
+
 Your new class comes with an initializer that takes values in the order you
 defined them.
+
 ```ruby
 e = Engine.new('V6', 'gasoline')
 # => #<Engine layout="V6", fuel="gasoline">
@@ -32,6 +45,8 @@ e = Engine.new(layout: 'V8', fuel: "gasoline")
 # => #<Engine layout="V8", fuel="gasoline">
 ```
 
+### Attributes
+
 Attribute getters and setters are built in.
 ```ruby
 e.fuel            # => "gasoline"
@@ -39,18 +54,118 @@ e.fuel = "diesel" # => "diesel"
 ```
 
 Attributes are accessible via hash style lookup too.
+
 ```ruby
 e[:layout]        # => "V8"
 e[:layout] = "V6" # => "V6"
 e[:foo] = "Bar"   # => ArgumentError: Invalid liner attribute: 'foo'
 ```
 
-Equality methods are also availble.
+If you want a full attribute hash, we have that (`to_h` and `to_hash` also work).
+
+```ruby
+e.liner # => { :layout => 'V6', :fuel => 'diesel' }
+```
+
+### Inspection
+
+It's always nice not to have to set up inspection (note that `to_s` is the same
+here).
+
+```ruby
+e.inspect
+# => #<Engine layout="V6", fuel="gasoline">
+```
+
+### Equality
+
+Normal equality methods are here.
 ```ruby
 e.eql? Engine.new(layout: 'I4')               # => false
 e == Engine.new(layout: 'V6', fuel: 'diesel') # => true
 ```
 
+### Serialization
+
+JSON serialization is ready after you require it.
+
+```ruby
+require 'json'
+e.to_json
+# => "{\"layout\":\"V6\",\"fuel\":\"gasoline\"}"
+```
+
+### Overriding
+
+#### Getters/Readers
+If you want to customize the way an attribute is read, just override the method
+like you would any accessor. You can access the raw value through either the instance variable,
+`read_attribute`, or `super`.
+
+```ruby
+class Taco < Liner.new(:filling)
+  def filling
+    if read_liner(:filling) == 'ground beef'
+      'Steak'
+    elsif @filling == 'unknown fish'
+      'Atlantic Cod'
+    else
+      super()
+    end
+  end
+end
+```
+
+Overridden getters will take precedence for the other features. This
+is probably desirable, just don't be surprised by it.
+
+```ruby
+taco = Taco.new("ground beef")
+# => #<Taco filling="Steak">
+taco[:filling] = 'unknown fish'
+# => 'unknown fish'
+taco.liner
+# => {:filling=>"Atlantic Cod"}
+```
+
+#### Setters/Writers
+It's the same scenario for customizing the writer. Set the real value
+through the instance variable, `write_attribute`, or `super`.
+
+```ruby
+class Bacon < Liner.new(:is_good)
+  def is_good=(good)
+    @is_good = true
+  end
+end
+```
+
+Again, the overridden method takes precendence, even with writers.
+
+```ruby
+generic_bacon = Bacon.new
+generic_bacon[:is_good] = false
+# => true
+```
+
+### Inheritance
+
+Inheritance of Liner classes works like any other Ruby class, but you can tack
+on extra attributes to child classes if you like.
+
+```ruby
+class Instrument
+  liner :key
+end
+
+class Guitar < Instrument
+  liner :strings
+end
+
+Guitar.new('C', 6)
+# => #<Guitar key="C", strings=6>
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/ext/class.rb

@@ -1,5 +1,5 @@
 Class.class_eval do
   def liner(*keys)
-    Liner.apply self, *keys
+    Liner.apply! self, *keys
   end
 end

data/lib/liner.rb

@@ -7,6 +7,8 @@ require 'liner/serializable'
 require 'ext/class'
 
 module Liner
+  # include all submodules when included
+  # @api public
   def self.included(base)
     [Base, Hashable, Equalizable, Inspectable, Serializable].each do |mod|
       base.send :include, mod
@@ -14,24 +16,39 @@ module Liner
   end
 end
 
+# Setup an anonymous class with liner keys
+# @param keys [Array] An array of symbols or strings which will serve as attributes
+# @return [Class]
+# @example Liner.new(:foo) # => #<Class:0x007fd0993bab98>
+# @api public
 def Liner.new(*keys)
-  apply Class.new, *keys
+  apply! Class.new, *keys
 end
 
-def Liner.apply(base, *keys)
+# Apply a liner to a given class
+# @param base [Class] A class to add a liner to
+# @param keys [Array] An array of symbols or strings which will serve as attributes
+# @return [Class] The class with a liner installed
+# @api public
+def Liner.apply!(base, *keys)
   keys = keys.map(&:to_sym).uniq.freeze
-  base.class_eval do
-    define_method :liner_keys do
-      begin
-        (super() + keys).uniq
-      rescue NoMethodError
-        keys
-      end
+
+  base.send(:define_method, :liner_keys) do
+    begin
+      (super() + keys).uniq
+    rescue NoMethodError
+      keys
+    end
+  end
+
+  base.send :include, Liner unless base < Liner
+
+  keys.each do |key|
+    unless base.method_defined? key
+      base.send(:define_method, key){ liner_get key }
     end
-    include Liner
-    keys.each do |key|
-      define_method(key){ self[key] }
-      define_method("#{key}="){ |value| self[key] = value }
+    unless base.method_defined? "#{key}="
+      base.send(:define_method, "#{key}="){ |value| liner_set key, value }
     end
   end
   base

data/lib/liner/base.rb

@@ -5,9 +5,31 @@ module Liner
         self.liner = args.first
       elsif args.count >= 1 && args.count <= liner_keys.count
         self.liner_values = args
-      elsif !args.empty?
-        raise ArgumentError, "Liner doesn't know how to initialize with `#{args}`."
       end
     end
   end
+
+  private
+
+  def liner_get(key)
+    key = key.to_sym
+    with_valid_attribute(key) do
+      instance_variable_get "@#{key}"
+    end
+  end
+
+  def liner_set(key, value)
+    key = key.to_sym
+    with_valid_attribute(key) do
+      instance_variable_set "@#{key}", value
+    end
+  end
+
+  def with_valid_attribute(key, &block)
+    if liner_keys.include?(key)
+      yield
+    else
+      raise ArgumentError, "Invalid liner attribute: '#{key}'"
+    end
+  end
 end

data/lib/liner/hashable.rb

@@ -1,30 +1,29 @@
 module Liner
   module Hashable
 
-    def liner
-      @liner ||= liner_keys.inject({}) { |h,k| h[k]=nil; h }
+    def [](key)
+      send key.to_sym
+    rescue NoMethodError
+      liner_get key
     end
 
-    def liner=(hash)
-      hash.each { |k,v| self[k] = hash[k] }
+    def []=(key,value)
+      send :"#{key}=", value
+    rescue NoMethodError
+      liner_set key, value
     end
 
-    def [](key)
-      liner[key.to_sym]
+    def liner
+      liner_keys.inject({}) { |h,k| h[k] = self[k]; h }.freeze
     end
 
-    def []=(key,value)
-      key = key.to_sym
-      if liner_keys.include?(key)
-        liner[key] = value
-      else
-        raise ArgumentError, "Invalid liner attribute: '#{key}'."
-      end
+    def liner=(hash)
+      hash.each { |k,v| self[k] = hash[k] }
     end
 
     def liner_values=(values)
-      values.each_with_index do |v,i|
-        self[liner_keys[i]] = v
+      values.each_with_index do |value, i|
+        self[liner_keys[i]] = value
       end
     end
 

data/lib/liner/version.rb

@@ -1,3 +1,3 @@
 module Liner
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/liner.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Liner::VERSION
   spec.authors       = ["Josh Lewis"]
   spec.email         = ["josh.w.lewis@gmail.com"]
-  spec.description   = %q{A liner for Ruby objects. Add attribute, inspection, and equality methods.}
-  spec.summary       = %q{A liner for Ruby objects. Add attribute, inspection, and equality methods.}
+  spec.description   = %q{A liner for Ruby objects. Add attribute, inspection, serialization, and equality methods.}
+  spec.summary       = %q{Liner is a lightweight library designed to enhance simple classes with a few conveniences and idioms while staying out of your way.}
   spec.homepage      = "https://github.com/joshwlewis/liner"
   spec.license       = "MIT"
 
@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "coveralls"
 end

data/test/liner/hashable_test.rb

@@ -6,6 +6,10 @@ describe Liner::Hashable do
     subject[:yeast].must_equal nil
   end
 
+  it "[] should not read invalid attributes" do
+    ->{ subject[:foo] }.must_raise ArgumentError
+  end
+
   it "#[]= should set attributes" do
     subject[:yeast]= "Top Fermenting"
     subject.yeast.must_equal "Top Fermenting"

data/test/test_helper.rb

@@ -1,8 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'liner'
 
-
 # create some dummy classes to test against with each of the supported usages.
 
 Beer = Liner.new :hops, :yeast

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liner
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-02 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,22 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A liner for Ruby objects. Add attribute, inspection, and equality methods.
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: A liner for Ruby objects. Add attribute, inspection, serialization, and
+  equality methods.
 email:
 - josh.w.lewis@gmail.com
 executables: []
@@ -60,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -103,7 +119,8 @@ rubyforge_project:
 rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
-summary: A liner for Ruby objects. Add attribute, inspection, and equality methods.
+summary: Liner is a lightweight library designed to enhance simple classes with a
+  few conveniences and idioms while staying out of your way.
 test_files:
 - test/liner/base_test.rb
 - test/liner/equalizable_test.rb
@@ -112,3 +129,4 @@ test_files:
 - test/liner/serializable_test.rb
 - test/liner_test.rb
 - test/test_helper.rb
+has_rdoc: