penetrator 0.1.0 → 0.1.6

data/README.md

@@ -2,8 +2,9 @@
 
 This gem aimed to help with reuse code in ruby projects.
 Highly inspired from http://github.com/makandra/modularity gem but slightly modified for supporting
-conventional *super* inheritance chaining methods.
-Also shameless borrowed code from ActiveSupport::Coerce and I should say thanks that Ruby Hackers, who wrote it.
+conventional *super* inheritance methods chaining.
+Also much of code was shamelessly borrowed from `ActiveSupport::Concern` and I should say thanks that Ruby Hackers, who wrote it.
+All what left to do for me - it's just take the best from both worlds.
 
 ## Installation
 
@@ -24,85 +25,161 @@ Or install it yourself as:
 
 *config/application.rb*
 ```ruby
-config.autoload_paths += Rails.root.join( 'app', 'traits' )
+    config.autoload_paths += Rails.root.join( 'app', 'traits' )
 ```
 
-*app/controllers/traits/crudable_trait.rb*
+File: *app/controllers/traits/crudable_trait.rb*
 ```ruby
-        module CrudableTrait
-          #
-          # Implementation
-          public
-
-          def index
-            @accomodation = resource
-            respond_to do |format|
-              format.html { render layout: take_layout }
-              format.json { render json:   resources   }
-              format.js
-            end
+
+      module CrudableTrait
+        included do
+         helper_method :resource, :resources # they are will be used in views
+        end
+        #
+        # Implementation
+        public
+
+        def index
+          respond_to do |format|
+            format.html { render layout: take_layout }
+            format.json { render json:   resources   }
+            format.js
           end
+        end
 
-          def show
-            respond_to do |format|
-              format.html { render layout: take_layout }
-              format.json { render json:   resource    }
-              format.js
-            end
+        def show
+          respond_to do |format|
+            format.html { render layout: take_layout }
+            format.json { render json:   resource    }
+            format.js
           end
+        end
 
-          # ... and so on ...
+        # ... and so on ...
 
-          private
-            def take_layout
-               # ...
-            end
+        private
+          def take_layout
+             # ...
+          end
 
-            def resource
-              @_resource ||= resource_class.all
-            end
-         end
+          def resource
+            @_resource ||= resource_class.find(params[:id])
+          end
+
+          def resources
+            @_resources ||= resource_class.order(default_order).all
+          end
+       end
 ```
 
-*app/controllers/accomodations_controller.rb*
+File: *app/controllers/accomodations_controller.rb*
 ```ruby
-        class AccomodationsController < ApplicationController
-          #
-          # CrudableTrait required this mehod
-          private
-          def resource_class
-            Accomodation
-          end
 
-          behave_like "crudable"
+      class AccomodationsController < ApplicationController
+        #
+        # CrudableTrait assumes that this mehod exists
+        private
+        def resource_class
+          Accomodation
+        end
 
-          # Override public traits method
-          def index
-            if current_user.is_admin?
-              # ...
-            else
-              super
-            end
-          end
+        behave_like "crudable"
 
-          private
-          # Override traits methods
-          #
-          def default_order
-            "accomodations.name desc"
+        # Override public traits method
+        def index
+          if current_user.is_admin?
+            # ...
+          else
+            super
           end
+        end
+
+        private
+
+        # Override traits methods
+        #
+        def default_order
+          "accomodations.name desc"
+        end
+
+        public
 
-          public
-          # Override traits methods
-          # with respecting call chaining
-          #
-          def kill_all_humans
-            "Yes" or super
+        # Override traits methods
+        # with respecting call chaining
+        #
+        def kill_all_humans
+          "Yes" or super
+        end
+
+      end
+```
+
+What makes this gem different from `ActiveSupport::Concern` ?
+Well, here you can _parameterize_ your included modules-traits!
+(Extracted from `spec/coerce_spec.rb` )
+
+File:  *app/traits/can_have_args_trait.rb*
+```ruby
+    module CanHaveArgsTrait
+      extend Penetrator::Concern
+      included do |*args|
+        args.each do |method_name|
+          define_method(method_name) do
+            method_name.to_s + "-chunked!"
           end
+        end
+      end # included
+    end # CanHaveArgs
+```
+
+File:  *app/models/my_model.rb*
+```ruby
+
+    class Victim
+      behaves_like :CanHaveArgs, 'arg1', 'arg2'
+    end
+
+    obj = Victim.new
 
+    obj.arg1  # => 'arg1-chunked!'
+    obj.arg2  # => 'arg2-chunked!'
+
+```
+
+Also you can freely utilize `ClassMethods` internal module as you usually do with `ActiveSupport::Concern`
+
+```ruby
+
+    module RichTrait
+      extend Penetrator::Concern
+      module ClassMethods
+        def class_method
+          ... add what you want ...
         end
+      end
+
+      def instance_method
+      end
+    end
+
 ```
 
+You can ever extend arbitrary instance of any class with your trait:
+
+```ruby
+
+    module HtmlSanitizerTrait
+      extend Penetrator::Concern
+
+      def cleanup
+        ....
+      end
+    end
+
+    string_of_dirty_html = "Something <span>dirty</span> and even <marquee>fearing ugly</marquee>
+    string_of_dirty_html.behave_like 'html_sanitizer'
+
+```
 
 
 ## Contributing

data/lib/penetrator/version.rb

@@ -1,4 +1,19 @@
 # -*- encoding : utf-8 -*-
+
 module Penetrator
-  VERSION = "0.1.0"
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 6
+
+    # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
+    #
+    # Example
+    #
+    #   Version.to_s # '1.0.2'
+    def self.to_s
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
 end

data/lib/penetrator.rb

@@ -1,8 +1,9 @@
 # -*- encoding : utf-8 -*-
 require "penetrator/inflector"
-require "penetrator/version"
 
 module Penetrator
+  autoload :Version, 'penetrator/version'
+
   module Concern
     def self.extended(base) #:nodoc:
       base.instance_variable_set("@_dependencies", [])
@@ -21,6 +22,11 @@ module Penetrator
       end
     end
 
+    def extend_object(obj)
+      super
+      (class << obj; self; end).instance_exec(*@_trait_args, &@_included_block) if instance_variable_defined?("@_included_block")
+    end
+
     def included(base = nil, &block)
       if base.nil?
         @_included_block = block
@@ -43,6 +49,13 @@ module Penetrator
         include trait
       end
     end # ClassMethods
+
+    def behaves_like(trait_name, *args)
+      full_name = "#{Penetrator::Inflector.camelize(trait_name.to_s)}Trait"
+      trait = Penetrator::Inflector.constantize(full_name)
+      trait.instance_variable_set(:@_trait_args, args)
+      extend trait
+    end
   end # Behavior
 
 end

data/penetrator.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "penetrator"
   gem.require_paths = ["lib"]
-  gem.version       = Penetrator::VERSION
+  gem.version       = Penetrator::Version.to_s
   if RUBY_VERSION < '1.9.0'
     gem.add_development_dependency "minitest"
   end

data/spec/{coerce_spec.rb → concern_spec.rb}

@@ -3,7 +3,7 @@ require 'penetrator'
 require 'minitest/spec'
 require 'minitest/autorun'
 
-describe 'behavior when trait can be parameterized by arguments passed into included module' do
+describe 'behavior when trait parameterized by arguments passed into included module' do
   module CanHaveArgsTrait
     extend Penetrator::Concern
     included do |*args|

data/spec/object_spec.rb

@@ -0,0 +1,54 @@
+# -*- encoding : utf-8 -*-
+require 'penetrator'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+describe 'when object of any class extended by trait' do
+  module ObjectRelatedTrait
+    extend Penetrator::Concern
+    def testing_method
+      "It Works!"
+    end
+  end
+
+  it 'could extend particular object' do
+     object = Object.new
+     object.behaves_like "object_related"
+
+     object.must_respond_to :testing_method
+     object.testing_method.must_be :==, 'It Works!'
+  end
+
+  it 'not extend others objects the same class' do
+     object = Object.new
+     object.behaves_like "object_related"
+
+     second_object = Object.new
+     second_object.wont_respond_to :testing_method
+  end
+
+end
+
+describe 'behavior when trait parameterized by arguments passed into included module' do
+  module CanHaveArgsTrait
+    extend Penetrator::Concern
+    included do |*args|
+      args.each do |method_name|
+        define_method(method_name) do
+          method_name.to_s
+        end
+      end
+    end # included
+  end # CanHaveArgs
+
+  it 'receive trait arguments' do
+    object = Object.new
+    object.behaves_like :CanHaveArgs, 'arg1', 'arg2'
+
+    object.must_respond_to :arg1
+    object.arg1.must_be :==, 'arg1'
+    object.must_respond_to :arg2
+    object.arg2.must_be :==, 'arg2'
+  end
+
+end # trait argument

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: penetrator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,8 +59,9 @@ files:
 - lib/penetrator/inflector.rb
 - lib/penetrator/version.rb
 - penetrator.gemspec
-- spec/coerce_spec.rb
+- spec/concern_spec.rb
 - spec/core_spec.rb
+- spec/object_spec.rb
 homepage: https://github.com/svenyurgensson/penetrator
 licenses: []
 post_install_message: 
@@ -86,5 +87,6 @@ signing_key:
 specification_version: 3
 summary: Implement traits behavior to get rid of code repetition
 test_files:
-- spec/coerce_spec.rb
+- spec/concern_spec.rb
 - spec/core_spec.rb
+- spec/object_spec.rb