liner 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53f068a96a64299ca295a0c1821a5232a4ec2618
-  data.tar.gz: 459fd2b8e24e184a5437744fa1ae3701c384d609
+  metadata.gz: 7bbfb3aba7d5aa9e37d5b7f9bf3192ba358ed87d
+  data.tar.gz: 9b69f55a62fb0e5d0ef4b4de8ccd3427bf64b190
 SHA512:
-  metadata.gz: 98f7de6a0c3580a6dd7c8774aa7b427b7819c30a28ad1dce9fdfd362fd3c6a9742df59f2c9a0b64508e943a802a3fa422c3f442c6529827d7acf5dab9e943bd1
-  data.tar.gz: 7d8e902c6662b26f751bee45f120855c21e3a300a66532fe536d4be439f5063745a352691f97788cd0461086a88bba3b6ff269327354d75c0761b381cf29abf3
+  metadata.gz: b07b23e891919b936ed3a1ad2f42db641490e558237547b2d8a85c234489d0815d089cedd738aa13d34fedeef9ba7a79fdc4b09312f963d4ab9193fbc54c9d0c
+  data.tar.gz: 7a1445ce77473f7f1fad7c63ad876780126b52dcd0b4ade0f0b869590e95cb4ce79322d9bff14cc9e77ff3c08088b2383fbbc6c1f6713d9c587f7011bda89151

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'pry'
 gemspec
+
+gem 'pry'
+gem 'yard'

data/README.md

@@ -100,7 +100,7 @@ e.to_json
 #### 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`.
+`liner_get`, or `super`.
 
 ```ruby
 class Taco < Liner.new(:filling)
@@ -130,7 +130,7 @@ taco.liner
 
 #### Setters/Writers
 It's the same scenario for customizing the writer. Set the real value
-through the instance variable, `write_attribute`, or `super`.
+through the instance variable, `liner_set`, or `super`.
 
 ```ruby
 class Bacon < Liner.new(:is_good)

data/lib/liner.rb

@@ -7,49 +7,62 @@ require 'liner/serializable'
 require 'ext/class'
 
 module Liner
-  # include all submodules when included
+
+  # List of liner attributes as an array of symbols
+  # @return [Array]
+  def self.liner_keys
+    []
+  end
+
+  # 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
+  # @example
+  #   Person = Class.new
+  #   Liner.apply! Person, :name, :occupation # => Person
   # @api public
-  def self.included(base)
-    [Base, Hashable, Equalizable, Inspectable, Serializable].each do |mod|
-      base.send :include, mod
+  def Liner.apply!(base, *keys)
+    keys = keys.map(&:to_sym).uniq
+
+    base.send(:define_singleton_method, :liner_keys) do
+      @liner_keys ||= begin
+        super() + keys
+      rescue NoMethodError
+        keys
+      end.uniq.freeze
     end
-  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
-end
+    base.send :include, Liner unless base < Liner
 
-# 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.send(:define_method, :liner_keys) do
-    begin
-      (super() + keys).uniq
-    rescue NoMethodError
-      keys
+    keys.each do |key|
+      unless base.method_defined? key
+        base.send(:define_method, key){ liner_get key }
+      end
+      unless base.method_defined? "#{key}="
+        base.send(:define_method, "#{key}="){ |value| liner_set key, value }
+      end
     end
+    base
   end
 
-  base.send :include, Liner unless base < Liner
+  # 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
+  end
 
-  keys.each do |key|
-    unless base.method_defined? key
-      base.send(:define_method, key){ liner_get key }
-    end
-    unless base.method_defined? "#{key}="
-      base.send(:define_method, "#{key}="){ |value| liner_set key, value }
+  # Includes liner submodules when included
+  # @api private
+  def self.included(base)
+    [Base, Hashable, Equalizable, Inspectable, Serializable].each do |mod|
+      base.send :include, mod
     end
   end
-  base
 end
+
+

data/lib/liner/base.rb

@@ -1,5 +1,8 @@
 module Liner
   module Base
+    # Create a new instance of a Liner class
+    # @param args [Hash, Array, nil] A hash of attribute-value pairs, an array of values or nil
+    # @return [Class] A new instance of the Liner class
     def initialize(*args)
       if args.count == 1 && args.first.respond_to?(:keys)
         self.liner = args.first
@@ -11,6 +14,10 @@ module Liner
 
   private
 
+  # Get a liner attribute.
+  # @param key [Symbol, String] The attribute to be read
+  # @return value [Object] The value of the attribute
+  # @api private
   def liner_get(key)
     key = key.to_sym
     with_valid_attribute(key) do
@@ -18,6 +25,11 @@ module Liner
     end
   end
 
+  # Set a liner attribute
+  # @param key [Symbol, String] The attribute to be set
+  # @param value [Object] The value to set the attribute to
+  # @return value [Object]
+  # @api private
   def liner_set(key, value)
     key = key.to_sym
     with_valid_attribute(key) do
@@ -25,6 +37,8 @@ module Liner
     end
   end
 
+  # Raise an error unless the key exists
+  # @api private
   def with_valid_attribute(key, &block)
     if liner_keys.include?(key)
       yield
@@ -32,4 +46,10 @@ module Liner
       raise ArgumentError, "Invalid liner attribute: '#{key}'"
     end
   end
+
+  # Delegate liner keys to the singleton class method
+  # @api private
+  def liner_keys
+    self.class.liner_keys
+  end
 end

data/lib/liner/equalizable.rb

@@ -1,10 +1,17 @@
 module Liner
   module Equalizable
+
+    # Test equality between a liner class instance and another object
+    # @param other [Object]
+    # @return [true, false]
     def ==(other)
       return false unless other.class == self.class
       liner == other.liner
     end
 
+    # Test equality between a liner class instance and another object
+    # @param other [Object]
+    # @return [true, false]
     def eql?(other)
       return false unless other.class == self.class
       liner.eql?(other.liner)

data/lib/liner/hashable.rb

@@ -1,32 +1,55 @@
 module Liner
   module Hashable
 
+    # Read a liner attribute
+    # @param key [Symbol, String] The attribute to fetch the value for
+    # @return [Object] The attribute value
+    # @api public
     def [](key)
       send key.to_sym
     rescue NoMethodError
       liner_get key
     end
 
+    # Set a liner attribute
+    # @param key [Symbol, String] The attribute to set the value for
+    # @param value [Object] The attribute value to set
+    # @return [Object] The attribute value
+    # @api public
     def []=(key,value)
       send :"#{key}=", value
     rescue NoMethodError
       liner_set key, value
     end
 
+    # Build a hash of liner attributes
+    # @return [Hash] A hash of liner attributes
+    # @api public
     def liner
       liner_keys.inject({}) { |h,k| h[k] = self[k]; h }.freeze
     end
 
+    # Set multiple attribute values
+    # @param hash [Hash] A hash of attribute-value pairs to set
+    # @return [Hash]
+    # @api public
     def liner=(hash)
       hash.each { |k,v| self[k] = hash[k] }
     end
 
+    # Set mulitple attribute values
+    # @param values [Array] Ordered array of attribute values
+    # @return [Array]
+    # @api public
     def liner_values=(values)
       values.each_with_index do |value, i|
         self[liner_keys[i]] = value
       end
     end
 
+    # Get a hash of attributes
+    # @return [Hash] An attribute-value hash
+    # @api public
     def to_h
       liner.dup
     end

data/lib/liner/inspectable.rb

@@ -1,5 +1,8 @@
 module Liner
   module Inspectable
+    # A handy inspection string
+    # @return [String]
+    # @api public
     def inspect
       attribute_string = liner.map{|k,v| "#{k}=#{v.inspect}"}.join(', ')
       "#<#{self.class} #{attribute_string}>"

data/lib/liner/serializable.rb

@@ -1,11 +1,17 @@
 module Liner
   module Serializable
-    def as_json(*)
-      to_h
-    end
-
+    # Convert a liner instances attributes to json
+    # @return [String] A JSON string of attributes
+    # @api public
     def to_json(*args)
       as_json.to_json(*args)
     end
+    
+    private
+
+    # @api private
+    def as_json(*)
+      to_h
+    end
   end
 end

data/lib/liner/version.rb

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

data/test/liner_test.rb

@@ -9,9 +9,9 @@ describe Liner do
     end
 
     it "should define liner_keys" do
-      beer.liner_keys.must_equal   [:hops, :yeast]
-      pizza.liner_keys.must_equal  [:crust, :sauce]
-      cheeseburger.liner_keys.must_equal [:bun, :meat, :cheese]
+      Beer.liner_keys.must_equal   [:hops, :yeast]
+      Pizza.liner_keys.must_equal  [:crust, :sauce]
+      Cheeseburger.liner_keys.must_equal [:bun, :meat, :cheese]
     end
 
     it "should define attribute getters" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler