penetrator 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.rvmrc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in penetrator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yury Batenko
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Penetrator
+
+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.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'penetrator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install penetrator
+
+## Usage
+(Rails specific example)
+
+*config/application.rb*
+```ruby
+config.autoload_paths += Dir[Rails.root.join( 'app', '**/*' )].select { |fn| File.directory?(fn) }
+```
+
+*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
+          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
+
+          private
+            def take_layout
+               # ...
+            end
+
+            def resource
+              @_resource ||= resource_class.all
+            end
+         end
+```
+
+*app/controllers/accomodations_controller.rb*
+```ruby
+        class AccomodationsController < ApplicationController
+          #
+          # CrudableTrait required parameters
+          private
+          def resource_class
+            Accomodation
+          end
+
+          behave_like "crudable"
+
+          # 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
+        end
+```
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Default: Run all specs.'
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.warning = true
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/penetrator/inflector.rb

@@ -0,0 +1,61 @@
+# -*- encoding : utf-8 -*-
+# These methods are backported from Rails so modularity works with plain Ruby.
+
+module Penetrator
+  class Inflector
+    class << self
+
+      # File activesupport/lib/active_support/inflector.rb, line 178
+      def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+        if first_letter_in_uppercase
+          lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+        else
+          lower_case_and_underscored_word.first.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+        end
+      end
+
+
+    if Module.method(:const_get).arity == 1
+      # Tries to find a constant with the name specified in the argument string:
+      #
+      #   "Module".constantize     # => Module
+      #   "Test::Unit".constantize # => Test::Unit
+      #
+      # The name is assumed to be the one of a top-level constant, no matter whether
+      # it starts with "::" or not. No lexical context is taken into account:
+      #
+      #   C = 'outside'
+      #   module M
+      #     C = 'inside'
+      #     C               # => 'inside'
+      #     "C".constantize # => 'outside', same as ::C
+      #   end
+      #
+      # NameError is raised when the name is not in CamelCase or the constant is
+      # unknown.
+      def constantize(camel_cased_word)
+        names = camel_cased_word.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end
+    else
+      def constantize(camel_cased_word) #:nodoc:
+        names = camel_cased_word.split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name, false) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end
+    end
+
+    end
+  end
+end

data/lib/penetrator/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module Penetrator
+  VERSION = "0.0.1"
+end

data/lib/penetrator.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+require "penetrator/inflector"
+require "penetrator/version"
+
+module Penetrator
+  module Behavior
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def behave_like(trait_name, *args)
+        full_name = "#{Penetrator::Inflector.camelize(trait_name.to_s)}Trait"
+        trait = Penetrator::Inflector.constantize(full_name)
+        trait_args_var = "@@" + trait_name.to_s.downcase.gsub(/[^_a-z]+/, '_')+"_args"
+        self.class_variable_set(trait_args_var.to_sym, (args || nil))
+        include trait
+      end
+    end
+
+  end
+end
+
+Object.send :include, Penetrator::Behavior

data/penetrator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/penetrator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yury Batenko"]
+  gem.email         = ["jurbat@gmail.com"]
+  gem.description   = %q{Implement traits behavior to get rid of code repetition}
+  gem.summary       = %q{Implement traits behavior to get rid of code repetition}
+  gem.homepage      = "https://github.com/svenyurgensson/penetrator"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "penetrator"
+  gem.require_paths = ["lib"]
+  gem.version       = Penetrator::VERSION
+  if RUBY_VERSION < '1.9.0'
+    gem.add_development_dependency "minitest"
+  end
+  gem.add_development_dependency "mocha"
+end

data/spec/core_spec.rb

@@ -0,0 +1,140 @@
+# -*- encoding : utf-8 -*-
+require 'penetrator'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+
+describe 'Class' do
+  it 'should be accesable' do
+    Class.must_respond_to :behave_like
+  end
+end # Class method
+
+
+describe 'mixing behavior' do
+
+  module FirstTrait
+    def test; end
+  end
+
+  it 'add trait methods' do
+    class Victim
+      behave_like 'first'
+    end
+
+    Victim.new.must_respond_to :test
+  end
+
+
+  module Outer
+    module InnerTrait
+      def inner_test; end
+    end
+  end
+
+
+  it 'add traits methods from nested modules' do
+    class Victim
+      behave_like 'outer/inner'
+    end
+    Victim.new.must_respond_to :inner_test
+  end
+
+end # mixing behavior
+
+
+describe 'methods chainings' do
+
+  module SuperTrait
+    def test
+      'from trait'
+    end
+  end
+
+  it 'have traits methods' do
+    class Victim
+      behave_like 'super'
+      def test
+        'this from class and that ' + super
+      end
+    end # Victim
+
+    Victim.new.test.must_equal 'this from class and that from trait'
+  end
+
+end # methods chainings
+
+describe 'callbacks' do
+  module CallbackTrait
+  end
+
+  it 'have traits methods' do
+    class Victim; end
+    CallbackTrait.expects(:included).with(Victim)
+    class Victim
+      behave_like 'callback'
+    end
+  end
+end # callbacks
+
+describe 'visibility' do
+  module VisibilityTrait
+    def public_method_from_trait;   end
+    protected
+    def protected_method_from_trait;  end
+    private
+    def private_method_from_trait;   end
+  end
+
+  it 'allow trait to define methods with different visibility' do
+    class Victim
+      behave_like 'visibility'
+    end
+
+    instance = Victim.new
+    instance.public_methods.collect(&:to_s).must_include('public_method_from_trait')
+    instance.protected_methods.collect(&:to_s).must_include('protected_method_from_trait')
+    instance.private_methods.collect(&:to_s).must_include('private_method_from_trait')
+
+  end
+
+end # visibility
+
+describe 'trait arguments' do
+  module HaveArgsTrait; end
+
+  it 'receive trait arguments' do
+    class Victim; end
+    Victim.expects(:behave_like).with('have_args', 'arg1', 'arg2')
+
+    class Victim
+      behave_like 'have_args', 'arg1', 'arg2'
+    end
+
+  end
+
+  it 'base holds arguments' do
+    class Victim
+      behave_like 'have_args', 'arg1', 'arg2'
+    end
+    Victim.class_variable_get(:@@have_args_args).must_equal ['arg1','arg2']
+  end
+
+
+  describe 'arguments defined before trait included' do
+    module HandyTrait
+      def self.included(base)
+        base.send :stub, base.class_variable_get(:@@handy_args)
+      end
+    end
+
+    class Victim; end
+    Victim.expects(:stub).with(['arg'])
+
+    class Victim
+      behave_like :handy, 'arg'
+    end
+  end # 'trait use arguments'
+
+
+end # trait argument

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: penetrator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yury Batenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70150947089080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70150947089080
+description: Implement traits behavior to get rid of code repetition
+email:
+- jurbat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/penetrator.rb
+- lib/penetrator/inflector.rb
+- lib/penetrator/version.rb
+- penetrator.gemspec
+- spec/core_spec.rb
+homepage: https://github.com/svenyurgensson/penetrator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Implement traits behavior to get rid of code repetition
+test_files:
+- spec/core_spec.rb