wrapit 0.2.0 → 0.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/README.md

@@ -1,5 +1,9 @@
 # Wrapit
 
+[![Code Climate](https://codeclimate.com/github/jdguzman/wrapit.png)](https://codeclimate.com/github/jdguzman/wrapit)
+[![Build Status](https://travis-ci.org/jdguzman/wrapit.svg?branch=master)](https://travis-ci.org/jdguzman/wrapit)
+[![Coverage Status](https://coveralls.io/repos/jdguzman/wrapit/badge.png?branch=master)](https://coveralls.io/r/jdguzman/wrapit?branch=master)
+
 Wrapit allows you to easily define attributes in a class that should be wrapped,
 or wrap attributes that have already been defined.  The wrapping logic comes from
 the [wrapped](https://github.com/mike-burns/wrapped) gem.
@@ -20,7 +24,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+So lets say we want to create some setters and getters for a class that come all
+wrapped and ready to go.
+
+    class Foo
+      include Wrapit::AttrWrappable
+
+      attr_wrappable :test_attr
+    end
+
+    foo = Foo.new
+
+    foo.test_attr = "bar"
+    foo.test_attr => #<Present:0x0000010ad6fc80 @value="bar">
+    foo.test_attr.unwrap => "bar"
+
+    foo.test_attr = nil
+    foo.test_attr => #<Blank:0x0000010d3064f8>
+    foo.test_attr.unwrap => IndexError: Blank has no value
+    foo.test_attr.unwrap_or("bar") => "bar"
+
+In addition to wrapping up the attribute readers, attr_wrappable creates *_naked* attribute writers:
+
+    foo.test_attr_naked => nil
+    foo.test_attr_naked = "bar"
+    foo.test_attr_naked => "bar"
+
+    # test_attr= is just an alias to test_attr_naked=
+    foo.test_attr = "foo"
+    foo.test_attr_naked = "foo"
+
+Now lets say you have a method you have inherited from a superclass you want to wrap.
+
+    class Foo
+      def test_method
+        "bar"
+      end
+    end
+
+    class Bar < Foo
+      include Wrapit::MethodWrappable
+
+      method_wrappable :test_method
+    end
+
+    bar = Bar.new
+
+    bar.test_method => #<Present:0x0000010ad6fc80 @value="bar">
+    bar.test_method.unwrap => "bar"
+    bar.test_method_naked => "bar"
+
+And that's it!
+
+## Limitations
+
+At the moment method_wrappable is only usable on methods defined in a superclass and
+that take no arguments.
+
+## TODO
+
+1. Add option to attr_wrappable to skip creating attribute writers.
+2. Make method_wrappable work with methods that take arguments.
+3. Look into method_wrappable working better in scenarios where we want to wrap a dynamic
+method. ie. ActiveRecord attributes.
 
 ## Contributing
 

data/lib/wrapit/method_wrappable.rb

@@ -6,6 +6,10 @@ module Wrapit::MethodWrappable
       def method_wrappable(*args)
         class_eval do
           args.each do |method|
+            define_method :"#{method}_naked" do
+              self.class.superclass.instance_method(method).bind(self).call
+            end
+
             define_method method do
               super().wrapped
             end

data/lib/wrapit/version.rb

@@ -1,3 +1,3 @@
 module Wrapit
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/spec_helper.rb

@@ -1 +1,5 @@
+require 'coveralls'
+
+Coveralls.wear!
+
 require 'wrapit'

data/spec/wrapit/attr_wrappable_spec.rb

@@ -3,22 +3,22 @@ require 'spec_helper'
 describe Wrapit::AttrWrappable do
   it "should add attr_wrappable method when included" do
     build_class
-    FooBar.private_methods.include?(:attr_wrappable).should be_true
+    expect(FooBar.private_methods.include?(:attr_wrappable)).to be true
     destroy_class
   end
 
   it "should add _naked attribute reader/writers with attr_wrappable" do
     build_class
     FooBar.module_eval { attr_wrappable :test_method }
-    FooBar.new.respond_to?(:test_method_naked).should be_true
-    FooBar.new.respond_to?(:test_method_naked=).should be_true
+    expect(FooBar.new.respond_to?(:test_method_naked)).to be true
+    expect(FooBar.new.respond_to?(:test_method_naked=)).to be true
     destroy_class
   end
 
   it "should create a wrapped reader with attr_wrappable" do
     build_class
     FooBar.module_eval { attr_wrappable :test_method }
-    FooBar.new.test_method.should be_kind_of Blank
+    expect(FooBar.new.test_method).to be_kind_of Blank
     destroy_class
   end
 
@@ -27,7 +27,7 @@ describe Wrapit::AttrWrappable do
     FooBar.module_eval { attr_wrappable :test_method }
     foo_bar = FooBar.new
     foo_bar.test_method = nil
-    foo_bar.test_method.should be_kind_of Blank
+    expect(foo_bar.test_method).to be_kind_of Blank
     destroy_class
   end
 
@@ -36,7 +36,7 @@ describe Wrapit::AttrWrappable do
     FooBar.module_eval { attr_wrappable :test_method }
     foo_bar = FooBar.new
     foo_bar.test_method = "something"
-    foo_bar.test_method.should be_kind_of Present
+    expect(foo_bar.test_method).to be_kind_of Present
     destroy_class
   end
 
@@ -45,7 +45,7 @@ describe Wrapit::AttrWrappable do
     FooBar.module_eval { attr_wrappable :test_method }
     foo_bar = FooBar.new
     foo_bar.test_method = "something"
-    foo_bar.test_method.unwrap.should eq foo_bar.test_method_naked
+    expect(foo_bar.test_method.unwrap).to eq foo_bar.test_method_naked
     destroy_class
   end
 

data/spec/wrapit/method_wrappable_spec.rb

@@ -3,14 +3,21 @@ require 'spec_helper'
 describe Wrapit::MethodWrappable do
   it "should add method_wrappable method when included" do
     build_class
-    FooBar.private_methods.include?(:method_wrappable).should be_true
+    expect(FooBar.private_methods.include?(:method_wrappable)).to be true
+    destroy_class
+  end
+
+  it "should add _naked attribute reader with method_wrappable" do
+    build_class
+    FooBar.module_eval { method_wrappable :to_s }
+    expect(FooBar.new.respond_to?(:to_s_naked)).to be true
     destroy_class
   end
 
   it "should create a wrapped version of method with method_wrappable" do
     build_class
     FooBar.module_eval { method_wrappable :to_s }
-    FooBar.new.to_s.should be_kind_of Present
+    expect(FooBar.new.to_s).to be_kind_of Present
     destroy_class
   end
 
@@ -18,7 +25,7 @@ describe Wrapit::MethodWrappable do
     build_class
     Object.module_eval { define_method :test_method do nil; end }
     FooBar.module_eval { method_wrappable :test_method }
-    FooBar.new.test_method.should be_kind_of Blank
+    expect(FooBar.new.test_method).to be_kind_of Blank
     destroy_class
   end
 
@@ -26,7 +33,16 @@ describe Wrapit::MethodWrappable do
     build_class
     Object.module_eval { define_method :test_method do "something"; end }
     FooBar.module_eval { method_wrappable :test_method }
-    FooBar.new.test_method.should be_kind_of Present
+    expect(FooBar.new.test_method).to be_kind_of Present
+    destroy_class
+  end
+
+  it "wrapped method should return same value as naked method" do
+    build_class
+    Object.module_eval { define_method :test_method do "something"; end }
+    FooBar.module_eval { method_wrappable :test_method }
+    foo_bar = FooBar.new
+    expect(foo_bar.test_method.unwrap).to eq foo_bar.test_method_naked
     destroy_class
   end
 

data/wrapit.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrapit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrap attributes of any class to explicitly avoid nils.
 email:
 - jdguzman@mac.com
@@ -83,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3391027308563744361
+      hash: -4453862613727087029
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3391027308563744361
+      hash: -4453862613727087029
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25