ruby-features 1.1.2 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27643cb1fa6b12baf10bf86fbc40226e2e70bc08
+  data.tar.gz: 2be53a6cc1404b1709b910fb8390663f4fc2d801
+SHA512:
+  metadata.gz: c03d3cef6917da453e06c12184e31988366f42183ed170a6308049ce87dd8790dfafb3a41df9151a49672c7d1a161359634638f3873f11b60d0695cbdc89f6d0
+  data.tar.gz: 170853e803e73904e1755fc688e24032d45df28304a5f12427f4e9a3f259b3de9a6978afb6f67c36af5ee4da7fb12836a894a786abc078ccba58c22383ba8a44

data/README.md

@@ -5,10 +5,10 @@ Ruby Features
 [![Climate](https://codeclimate.com/github/stokarenko/ruby-features/badges/gpa.svg)](https://codeclimate.com/github/stokarenko/ruby-features)
 [![Coverage](https://codeclimate.com/github/stokarenko/ruby-features/badges/coverage.svg)](https://codeclimate.com/github/stokarenko/ruby-features/coverage)
 
-Ruby Features makes the extending of Ruby classes and modules to be easy, safe and controlled.
+Ruby Features allow the extending of Ruby classes and modules to become easy, safe and controlled.
 
 ## Why?
-Lets ask, is good to write the code like this:
+Lets ask, is that good to write the code like this:
 ```ruby
 String.send :include, MyStringExtension
 ```
@@ -22,7 +22,7 @@ Object.class_eval do
 end
 ```
 
-The question is about motivation to write such things. Lets skip well-known reason like
+The matter is in motivation to write such things. Lets skip the well-known reasons like
 > Because I can! That is Ruby baby, lets make some anarchy!
 
 but say:
@@ -37,12 +37,12 @@ library, infected by massive patches to core entities.
 Ruby Features goal is to take that under control.
 
 The main features are:
-* No any dependencies;
+* No dependencies;
 * Built-in lazy load;
 * Supports ActiveSupport lazy load as well;
 * Stimulates the clear extending, but prevents monkey patching;
 * Gives the control what core extensions to apply;
-* Any moment gives the knowledge who and how exactly affected to programming entities.
+* Gives the understading who and how exactly affected to programming entities.
 
 ## requirements
 * Ruby >= 1.9.3
@@ -68,7 +68,7 @@ to apply third-party features.
 
 ## Usage
 ### Feature definition
-Feature file name should ends with `_feature.rb`.
+Feature file name should end with `_feature.rb`.
 
 Lets define the feature in `lib/features/something_useful_feature.rb`:
 ```ruby
@@ -80,6 +80,16 @@ RubyFeatures.define 'some_namespace/something_useful' do
       attr_accessor :useful_variable
     end
 
+    rewrite_instance_methods do
+      # rewrite instance methods
+      # call `super` to reach the rewritten method
+      def existing_instance_method
+        # some code before super
+        super
+        # some code after super
+      end
+    end
+
     instance_methods do
       # instance methods
       def useful_instance_method
@@ -91,17 +101,17 @@ RubyFeatures.define 'some_namespace/something_useful' do
       def useful_class_method
       end
     end
+  end
 
-    apply_to 'ActiveRecord::Relation' do
-      # feature can contain several apply_to definition
-    end
-
+  apply_to 'ActiveRecord::Relation' do
+    # feature can contain several apply_to definition
   end
+
 end
 ```
 
 ### Dependencies
-The dependencies from other Ruby Features can be defined like:
+The dependencies on other Ruby Features can be defined like:
 ```ruby
 RubyFeatures.define 'main_feature' do
   dependency 'dependent_feature1'
@@ -110,7 +120,7 @@ end
 ```
 
 ### Conditions
-Sometimes is required to apply different things, dependent on some criteria:
+Sometimes it`s required to apply different things, depending on some criteria:
 ```ruby
 RubyFeatures.define 'some_namespace/something_useful' do
   apply_to 'ActiveRecord::Base' do
@@ -131,7 +141,7 @@ end
 ```
 
 It's bad to do like that, because the mixin applied by Ruby Features became to be not static.
-That cause not predictable behavior.
+That causes unpredictable behavior.
 
 Ruby Features provides the `conditions` mechanism to avoid such problem:
 ```ruby
@@ -156,7 +166,7 @@ RubyFeatures.define 'some_namespace/something_useful' do
 end
 ```
 
-All feature definition helpers supports the conditions:
+All DSL methods support the conditions:
 ```ruby
 apply_to 'ActiveRecord::Base', if: :first_criteria do; end
 
@@ -218,14 +228,14 @@ RubyFeatures.find_in_path(File.expand_path('../lib/features', __FILE__))
 ```
 
 ### Feature applying
-Feature can be applied immediately after it's definition:
+Feature can be applied immediately after its definition:
 ```ruby
 RubyFeatures.define 'some_namespace/something_useful' do
   # definition
 end.apply
 ```
 
-Features can be applied right after loading from path:
+Features can be applied immediately after loading from path:
 ```ruby
 RubyFeatures.find_in_path(File.expand_path('../lib/features', __FILE__)).apply_all
 ```
@@ -238,12 +248,12 @@ RubyFeatures.apply 'some_namespace/something_useful'
 ```
 
 ## Changes
+### v1.2.0
+* Added rewrite_instance_methods.
+
 ### v1.1.0
 * Added conditions.
 * Added dependencies.
 
-## TODO
-* ActionDispatch with ActiveSupport lazy_load
-
 ## License
 MIT License. Copyright (c) 2015 Sergey Tokarenko

data/lib/ruby-features/concern/apply_to.rb

@@ -33,18 +33,29 @@ module RubyFeatures
         _methods('Include', asserts, block)
       end
 
+      def rewrite_instance_methods(asserts = {}, &block)
+        _methods('RewriteInstance', asserts, block)
+      end
+
       def _apply_methods(target_class)
         constants.each do |constant|
-          mixin_method, existing_methods_method = case(constant)
-          when /^Extend/ then [:extend, :methods]
-          when /^Include/ then [:include, :instance_methods]
+          mixin_method, existing_methods_method, existing_methods_check = case(constant)
+          when /^Extend/ then [:extend, :methods, :exclusion]
+          when /^Include/ then [:include, :instance_methods, :exclusion]
+          when /^RewriteInstance/ then [:prepend, :instance_methods, :inclusion]
           else raise ArgumentError.new("Wrong mixin constant: #{constant}")
           end
 
           mixin = const_get(constant)
 
-          common_methods = target_class.public_send(existing_methods_method) & mixin.instance_methods
-          raise NameError.new("Tried to #{mixin_method} already existing methods: #{common_methods.inspect}") unless common_methods.empty?
+          case(existing_methods_check)
+          when :exclusion
+            existing_methods = mixin.instance_methods & target_class.public_send(existing_methods_method)
+            raise NameError.new("Tried to #{mixin_method} already existing methods: #{existing_methods.inspect}") unless existing_methods.empty?
+          when :inclusion
+            not_existing_methods = mixin.instance_methods - target_class.public_send(existing_methods_method)
+            raise NameError.new("Tried to #{mixin_method} not existing methods: #{not_existing_methods.inspect}") unless not_existing_methods.empty?
+          end
 
           target_class.send(mixin_method, mixin)
         end

data/lib/ruby-features/version.rb

@@ -1,3 +1,3 @@
 module RubyFeatures
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/define_spec.rb

@@ -31,6 +31,28 @@ describe RubyFeatures::Concern::Feature do
     )
   end
 
+  it 'should apply rewrite instance methods' do
+    test_class.class_eval do
+      def test_rewrite_instance_method
+        2
+      end
+    end
+
+    expect{
+      define_test_feature('rewrite_instance_methods_feature') do
+        rewrite_instance_methods do
+          def test_rewrite_instance_method
+            3 * super
+          end
+        end
+      end.apply
+    }.to change{test_class.new.test_rewrite_instance_method}.from(2).to(6)
+
+    expect(test_class.included_modules).to include(
+      RubyFeatures::Mixins::DefineTestModule::DefineTestClass::RewriteInstanceMethodsFeature::DefineTestModule::DefineTestClass::RewriteInstance
+    )
+  end
+
   it 'should process applied block' do
     expect{
       define_test_feature('applied_block') do
@@ -75,4 +97,14 @@ describe RubyFeatures::Concern::Feature do
     }.to raise_error(/Tried to include already existing methods: \[:existing_instance_method\]/)
   end
 
+  it 'should raise error if target has no feature rewrite instance method' do
+    expect{
+      define_test_feature('not_existing_rewrite_instance_method') do
+        rewrite_instance_methods do
+          def not_existing_instance_method; end
+        end
+      end.apply
+    }.to raise_error(/Tried to prepend not existing methods: \[:not_existing_instance_method\]/)
+  end
+
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: ruby-features
 version: !ruby/object:Gem::Version
-  version: 1.1.2
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Sergey Tokarenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-01 00:00:00.000000000 Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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: Makes extending of Ruby classes and modules to be easy, safe and controlled.
@@ -33,23 +30,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/generators/ruby_features/install_generator.rb
 - lib/generators/ruby_features/templates/ruby-features.rb
+- lib/ruby-features.rb
 - lib/ruby-features/concern/apply_to.rb
 - lib/ruby-features/concern/feature.rb
 - lib/ruby-features/conditions.rb
 - lib/ruby-features/container.rb
 - lib/ruby-features/lazy.rb
 - lib/ruby-features/mixins.rb
+- lib/ruby-features/utils.rb
 - lib/ruby-features/utils/const_accessor_19.rb
 - lib/ruby-features/utils/const_accessor_20.rb
 - lib/ruby-features/utils/inflector.rb
 - lib/ruby-features/utils/inflector_active_support.rb
-- lib/ruby-features/utils.rb
 - lib/ruby-features/version.rb
-- lib/ruby-features.rb
-- LICENSE
-- README.md
 - spec/conditions_spec.rb
 - spec/define_spec.rb
 - spec/find_and_apply_spec.rb
@@ -62,27 +59,26 @@ files:
 homepage: https://github.com/stokarenko/ruby-features
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Makes extending of Ruby classes and modules to be easy, safe and controlled.
 test_files:
 - spec/conditions_spec.rb