attach_function 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 184c80c899df350d373fb5f60ddbc995a379a8f2
+  data.tar.gz: f02923c5fd1d28b228034f713d5742fde4c4d400
+SHA512:
+  metadata.gz: dcbd1c3e00246c42483b3084afc9d8d799af97fcff6771e884d7c79cd422da282d906971a85d83199604330b069671aa4d572c825095aa964d738cd5a65cf7dd
+  data.tar.gz: 473b3497787bfd6bf5ae9b4362e3f9981018c0a9ddd09cd682bf495144ca8fff4a49f4dec3b66cc79c26acd225b2b6cf580ee0229a894a3e247910fab5141333

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,53 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch('spec/spec_helper.rb')                                               { "spec" }
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})                                                   { |m| "spec/#{m[1]}_spec.rb" }
+end
+
+
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end

data/README.md

@@ -0,0 +1,68 @@
+# AttachFunction
+
+AttachFunction 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 Example: 
+
+    require 'attach_function'
+
+    module Math
+
+      #This will contain the method versions of the functions defined in the Math module
+      module MethodVersions
+        #Get the attach_function macro
+        extend AttachFunction
+        #Apply it to all methods of the Math module that aren't Object methods
+        (Math.methods - Object.methods).each do |m|
+          puts "Attaching #{m}"
+          attach_function m
+        end
+      end
+    end
+
+    #Now we include the Math::MethodVersions in Numeric
+    Numeric.include(Math::MethodVersions)
+    #And now we can do this:
+    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.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attach_function'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attach_function
+
+## Usage
+
+User it in any way you like.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/i_rewriter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/attach_function.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ostruct'
+
+gem = OpenStruct.new
+gem.name = File.basename(File.dirname(__FILE__))
+require "#{gem.name}/version"
+gem.module = AttachFunction
+
+Gem::Specification.new do |spec|
+
+  spec.name          = gem.name
+  spec.version       = (gem.module)::VERSION
+  spec.summary       = %q{True in-place file-editing}
+  spec.description   = %q{True in-place file-editing (i.e, inode(input) == inode(output)) like with sed, awk, or `ruby i -{p|n}e`, but truly in-place}
+
+  spec.authors       = ["Petr Skocik"]
+  spec.email         = ["pskocik@gmail.com"]
+  spec.homepage      = "https://github.com/pjump/#{spec.name}.git"
+  spec.licenses      = %w[gplv2]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "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 "guard-bundler"
+end

data/examples/enclosing_scope.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'attach_function'
+
+module Math
+  module MethodVersions
+    extend AttachFunction
+    (Math.methods - Object.methods).each do |m|
+      puts "Attaching #{m}"
+      attach_function m
+    end
+  end
+end
+
+Numeric.include(Math::MethodVersions)
+p "3.14.sin = #{3.14.sin}"
+p "10.log  = #{10.log10}"
+p "4.sqrt  = #{4.sqrt}"

data/lib/attach_function.rb

@@ -0,0 +1,59 @@
+#!/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
+    if function_symbol.match(/(.*)(?:::|\.)([^:.]*)$/)
+      receiver, function_method = $1, $2
+      receiver = receiver != "" && eval(receiver) || Object
+    else
+      #No explicit receiver
+      function_method = function_symbol
+      #If no receiver is specified, send it to self
+      receiver = self
+      #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)
+      end
+    end
+    
+    return [ receiver, function_method ]
+  end
+
+  def attach_function(method_name = nil, function_symbol)
+    receiver, message = _receiver_and_message(method_name, function_symbol)
+
+    #If no method_name is given, use the basename of the function being attached
+    method_name ||= message
+
+    #The core functionality
+    define_method method_name do |*args|
+      receiver.send(message, self, *args)
+    end
+  end
+end

data/lib/attach_function/version.rb

@@ -0,0 +1,3 @@
+module AttachFunction
+  VERSION = "0.1.0"
+end

data/spec/attach_function_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+module Foo
+  def self.add_foo(string)
+    string + " foo"
+  end
+
+  #module MethodVersions
+  #extend AttachFunction
+  #attach_function :add_foo
+  #end
+end
+module Three
+  def self.add_three(number)
+    number + 3
+  end
+  #module MethodVersions
+  #extend AttachFunction
+  #attach_function :add_three
+  #end
+end
+
+module A; end
+module ::A; module B; end; end
+
+describe AttachFunction do
+  it 'has a version number' do
+    expect(AttachFunction::VERSION).not_to be nil
+  end
+  it "should define an instance method named 'attach_function'" do
+    expect(subject.instance_methods(false)).to include(:attach_function)
+  end
+
+  describe "resolving receivers" do
+    {
+      '::A.m' => [::A, 'm'],
+      '::A::m' => [::A, 'm'],
+      'A.m' => [A, 'm'],
+      'A::m' => [A, 'm'],
+      '::A::B.m' => [::A::B, 'm'],
+      '::A::B::m' => [::A::B, 'm'],
+      '::A::B.m' => [::A::B, 'm'],
+      '::A::B::m' => [::A::B, 'm'],
+    }.each_pair do |k,answers|
+      it "should resolve #{k} to #{answers.inspect}" do
+        extend AttachFunction
+        expect(_receiver_and_message('attach_here',k)).to eq(answers)
+      end
+    end
+
+    context "same name and target in the same scope" do
+      enclosing_scope = self
+      #Don't know how to test this since it creates an unnamed scope
+      xit "resolves relatively to the enclosing scope" do
+        this_scope = self
+        extend AttachFunction
+        expect(this_scope).not_to eq(enclosing_scope)
+        expect(_receiver_and_message(nil,'m')).to eq([ enclosing_scope, 'm'])
+      end
+    end
+
+
+    class MyString < String; end
+    class MyInt < Integer; end
+
+    let(:my_string) { MyString.new("my string") }
+    let(:my_int) { MyInt.new(7) }
+
+    it "works with absolute names from a different scope" do
+      module AddFooMethod; end
+      expect {
+        module AddFooMethod
+          extend AttachFunction
+          attach_function nil,"::Foo::add_foo"
+        end
+      }.not_to raise_error
+      my_string.extend(AddFooMethod)
+      expect(my_string).to respond_to(:add_foo)
+      expect(my_string.add_foo).to eq("my string foo")
+    end
+    context "same scope" do 
+      class TestClass
+        def add_bar(obj)
+          puts "#{obj} + bar"
+        end
+      end
+      it "works with the same scope as long as we're using a different name" do
+        TestClass.extend AttachFunction
+        expect(TestClass.new).not_to respond_to(:add_bar_to_self) 
+        class TestClass
+          attach_function :add_bar_to_self, :add_bar
+        end
+        expect(TestClass.new).to respond_to(:add_bar_to_self) 
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+gem_name = File.basename(File.expand_path('../../', __FILE__))
+require gem_name

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: attach_function
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Petr Skocik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: True in-place file-editing (i.e, inode(input) == inode(output)) like
+  with sed, awk, or `ruby i -{p|n}e`, but truly in-place
+email:
+- pskocik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- attach_function.gemspec
+- examples/enclosing_scope.rb
+- lib/attach_function.rb
+- lib/attach_function/version.rb
+- spec/attach_function_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pjump/attach_function.git
+licenses:
+- gplv2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: True in-place file-editing
+test_files:
+- spec/attach_function_spec.rb
+- spec/spec_helper.rb