attach_function 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13ee26dfe343552e2bc5fd7807e08afab1a03bd4
-  data.tar.gz: 93789012ea84d1177721e0ec6b851e473816bee4
+  metadata.gz: 11e67fe07ac303c8f2c3fc3ca1ca130185dc91ac
+  data.tar.gz: 45b2be4c31976b5e5fccf18b49485a4ea06dad91
 SHA512:
-  metadata.gz: 132e09d24a243b0624269cc0d22dfab4959f8f36371d007acf829a0d3a4449d7153da4661d18c3c8a1ab6504da7096df9edb28207ed76cb7705d7fafd93c88fc
-  data.tar.gz: 41cb13978e31d6aa13df7188376a4603df519a04e93d890726d7f0ea9bc42399bffc121488674452f956aaa5b022c8fbd383735ef403dd07d0d02aac5d6b93f7
+  metadata.gz: b752860396416ac322fce4b49ba243a3ad778d316bb046d79d8392b3a1dca2aa697fb7870be5c2aa6dd43e91187154dcc5e75af79f4f4b3590f019786b203b7b
+  data.tar.gz: 74ee96c15175952138ee4cef1ad71a7726058be0b01e2c8e64ca2004a47562b0019332126f817c50bc7861dffe64e4d7ea9dd4e889e1e5a50db343c3249bcc9d

data/README.md

@@ -31,15 +31,39 @@ Numeric.include(Math::MethodVersions)
 p "3.14.sin = #{3.14.sin}"
 p "10.log  = #{10.log10}"
 p "4.sqrt  = #{4.sqrt}"
-```
 
 #The functionality that has been added to Numeric in this way is contained in the Math::MethodVersions mixin.
 #I consider this much nicer than rudely monkepatching methods right onto a core class.
 #This way, library users can see (in pry, for example, or via introspection) where a certain added method came from, and possibly filter it out.
 #(Ruby doesn't currently support unmixing).
 
+```
+
    
 See the specs and the example folder for more examples.
+
+## Versioning
+
+### Version number for machines
+
+This gem uses a slightly modified version of the **SemVer** specification, namely:
+```ruby
+    spec.version = "BREAKING.PATCHES.NONBREAKING"
+```
+You can use this versioning with your dependency tools, only you have a somewhat stronger guarantees that your
+code won't break if you limit yourself to the third number, but you need to allow second level updates in order to
+get (security and other) patches.
+
+### Version number for humans
+Since the above-described type of versioning doesn't tell you anything about the functional state of the gem (you can go from a "hello world" to a full blown operating system
+without making a breaking change, as long as your operating system prints "hello world" to the screen) (SemVer, when used correctly, doesn't tell anything about the functional state of a software package either)
+A second human-friendly version number can be found in `spec.metadata[:human_version]`.
+
+The magnitude of this version number shall be made to correspond to actual functional changes in the software.
+If I've worked a lot on the package, I'll make it move a lot, but unless I've made breaking changes, I'll stick to only moving the third number in the `spec.version` version.
+This number is for you. If you see it increase a lot, it probably means much more new goodies, but is less strictly defined then the version number for the machine.  (I reserve the right to later change the way I change this number).
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -2,6 +2,5 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
-
 task :default => :spec
 

data/VERSIONING.md

@@ -0,0 +1,22 @@
+# Versioning
+
+## Version number for machines
+
+This gem uses a slightly modified version of the **SemVer** specification, namely:
+```ruby
+    spec.version = "BREAKING.PATCHES.NONBREAKING"
+```
+You can use this versioning with your dependency tools, only you have a somewhat stronger guarantees that your
+code won't break if you limit yourself to the third number, but you need to allow second level updates in order to
+get (security and other) patches.
+
+## Version number for humans
+Since the above-described type of versioning doesn't tell you anything about the functional state of the gem (you can go from a "hello world" to a full blown operating system
+without making a breaking change, as long as your operating system prints "hello world" to the screen) (SemVer, when used correctly, doesn't tell anything about the functional state of a software package either)
+A second human-friendly version number can be found in `spec.metadata[:human_version]`.
+
+The magnitude of this version number shall be made to correspond to actual functional changes in the software.
+If I've worked a lot on the package, I'll make it move a lot, but unless I've made breaking changes, I'll stick to only moving the third number in the `spec.version` version.
+This number is for you. If you see it increase a lot, it probably means much more new goodies, but is less strictly defined then the version number for the machine.  (I reserve the right to later change the way I change this number).
+
+

data/attach_function.gemspec

@@ -5,7 +5,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ostruct'
 
 gem = OpenStruct.new
-gem.name = File.basename(File.dirname(__FILE__))
+gem.name = File.basename(File.expand_path(File.dirname(__FILE__)))
+
 require "#{gem.name}/version"
 gem.module = AttachFunction
 
@@ -13,6 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.name          = gem.name
   spec.version       = (gem.module)::VERSION
+  #spec.metadata[:human_version] = (gem.module)::HUMAN_VERSION
   spec.summary       = %q{Macro to attach a module function to an object by fixing its first argument to self}
   spec.description   = %q{Macro to attach a module function to an object by fixing its first argument to self}
 
@@ -26,10 +28,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  #spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "guard", "2.12"
   spec.add_development_dependency "guard-rspec"
+  #spec.add_development_dependency "listen"
+  #spec.add_development_dependency "highline"
   spec.add_development_dependency "guard-bundler"
 end

data/lib/attach_function/version.rb

@@ -1,3 +1,4 @@
 module AttachFunction
-  VERSION = "0.1.1"
+  VERSION = "0.2.2"
+  HUMAN_VERSION = "1.0.3"
 end

data/lib/attach_function.rb

@@ -1,27 +1,6 @@
 #!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
 module AttachFunction
-  #
-  #attach_function defines new methods that are partial applications of a target function where the first argument to the target function gets fixed to self.
-  #
-  #The name of the newly defined method will be the basename of the target function (the module path gets stripped) or a user-specified name.
-  #The receiver of relatively specified parameter functions will be the current module, if a user-specified name is given and 
-  #the user-specified name is not the same as the basename of the target function, or the enclosing module, if no-user specified name is provided or 
-  #if the user-specified name is the same as the basename of the parameter.
-  #
-  #Usage: 
-  #
-  #module MyModule
-  #   def function_method1(arg1, arg2); end
-  #   def function_method2(arg1); end
-  #
-  #   module MethodVersions
-  #     extend Attachmethod
-  #     attach_function :function_method1
-  #     attach_function :function_method2
-  #   end
-  #   
-  #See the specs and the example folder for more examples.
   
   def _receiver_and_message(method_name, function_symbol)
     #Parse the function symbol to get the receiver and the function's basename
@@ -36,15 +15,41 @@ module AttachFunction
       #Can't send to self if method_name == function_method (or it will recurse and crash):
       #   send it to the outer module/class, if there's no outer module, send it to Object
       if (method_name ||= function_method) == function_method
-        receiver = self.name
-        outer_module = receiver.rpartition('::').first
-        receiver = outer_module == "" ? Object : eval(outer_module)
+        receiver = Object.const_get(outer_module_name(name))
       end
     end
     
     return [ receiver, function_method ]
   end
 
+  #Give a fully qualified name of the outer module for a name assumed to be fully qualified
+  #(:: is prepended unless it's already there)
+  def outer_module_name(name)
+    outer_module = name.rpartition('::').first
+    outer_module.sub!(/^::/,'')
+    return outer_module == "" ? '::Object' : ('::'+outer_module)
+  end
+  
+  #attach_function defines new methods that are partial applications of a target function where the first argument to the target function gets fixed to self.
+  #
+  #The name of the newly defined method will be the basename of the target function (the module path gets stripped) or a user-specified name.
+  #The receiver of relatively specified parameter functions will be the current module, if a user-specified name is given and 
+  #the user-specified name is not the same as the basename of the target function, or the enclosing module, if no-user specified name is provided or 
+  #if the user-specified name is the same as the basename of the parameter.
+  #
+  #Usage: 
+  #
+  #module MyModule
+  #   def function_method1(arg1, arg2); end
+  #   def function_method2(arg1); end
+  #
+  #   module MethodVersions
+  #     extend Attachmethod
+  #     attach_function :function_method1
+  #     attach_function :function_method2
+  #   end
+  #   
+  #See the specs and the example folder for more examples.
   def attach_function(method_name = nil, function_symbol)
     receiver, message = _receiver_and_message(method_name, function_symbol)
 
@@ -56,4 +61,13 @@ module AttachFunction
       receiver.send(message, self, *args)
     end
   end
+
+  #Attaches all uninherited (by default, pass true to change that) public class methods
+  #of the enclosing module or of Object
+  def attach_outer_class_methods(inherited = false)
+    outer_module = Object.const_get(outer_module_name(name))
+    outer_module.methods(inherited).each do |m|
+      attach_function m
+    end
+  end
 end

data/spec/attach_function_spec.rb

@@ -27,6 +27,21 @@ describe AttachFunction do
   it 'has a version number' do
     expect(AttachFunction::VERSION).not_to be nil
   end
+  describe "#_outer_module_name" do
+    extend AttachFunction
+    {
+      '::A::M' => "::A",
+      'A::m' => "::A",
+      '::A::B::M' => "::A::B",
+      '::A' => "::Object",
+      'A' => "::Object"
+    }.each_pair do |k,answers|
+        it "should resolve #{k} to #{answers.inspect}" do
+          extend AttachFunction
+          expect(outer_module_name(k)).to eq(answers)
+        end
+    end
+  end
   it "should define an instance method named 'attach_function'" do
     expect(subject.instance_methods(false)).to include(:attach_function)
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: attach_function
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Petr Skocik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2015-03-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +95,8 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- VERSIONING.md
+- attach_function-0.1.2.gem
 - attach_function.gemspec
 - examples/enclosing_scope.rb
 - lib/attach_function.rb
@@ -135,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Macro to attach a module function to an object by fixing its first argument