generate_method 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1aecfbdbc29d8cf9e86453a1a39971ecd6411ae
+  data.tar.gz: 861f1c8d360a396f8eceb66536d227929843ce2a
+SHA512:
+  metadata.gz: 424546393cb2758fba26e81e4ca3cca9341d0f6d146de388a258194fadcb0a18d38b89c777d8978392c9dbcc8f2df0b34b4bc2e0a773368377a085d7f9640407
+  data.tar.gz: c807adb7103e542da8efa14af06cbe4414b27b3e758108b1d1b583ae64791198f40b338fa8d8e1bfefb5861279fde50b6b60354dc8c5cf2f1f33d55ccfe87c68

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 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,141 @@
+# generate_method [![Gem Version](https://badge.fury.io/rb/generate_method.svg)](http://badge.fury.io/rb/generate_method)
+
+Nicely generate methods on a Class or Module, by using module inclusion
+(inheritence) - allowing your gem's users to override your generated methods
+nicely.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'generate_method'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install generate_method
+
+## Usage
+
+Your gem has a simple method that generates methods on your users' `Module`.
+
+You would usually do it like this:
+
+```ruby
+class Module
+  def attr_reader(name)
+    define_method(name) do
+      instance_variable_get("@#{name}")
+    end
+  end
+end
+```
+
+From now on, will be revised like this:
+
+```ruby
+class Module
+  # When the method's name is dynamic:
+  def attr_reader(name)
+    generate_method(name) do
+      instance_variable_get("@#{name}")
+    end
+  end
+  # When the method's name is fixed:
+  # (also more efficient when generating multiple methods)
+  def create_reader
+    generate_methods do
+      def reader
+        @reader
+      end
+    end
+  end
+end
+```
+
+By using one of the above syntax, a few problems will be solved:
+
+### Ancestors stack
+
+When using `generate_methods` the generated methods will be added to the
+ancestors stack, so if your gem's user decides to override your method and call
+`super` to get your implementation. The original 'bad' implementation will not
+allow it because `define_method` will implement on the base class's level and
+therefore re-implementing it will not allow calling `super` on the same level.
+
+```ruby
+class MyClass
+  attr_reader :x
+  def x
+    super.to_i
+  end
+end
+instance = MyClass.new(x: "123")
+instance.x
+=> 123
+```
+
+### Overriding existing methods
+
+You can add `overrider: <overrider_name>` option to the `generate_method` call. This will
+cause existing methods in the class to be aliased into
+`<method_name>_without_<overrider_name>` (pushing ?/!,= to the end of the
+method name). That way you can easily call the overriden method in your
+generated method.
+
+```ruby
+class Module
+  def increment_attr(name)
+    generate_method(name, overrider: :increment) do
+      send(:"#{name}_without_increment") + 1
+    end
+  end
+end
+```
+
+Sometimes the method is implemented in `method_missing` of the parent (like
+with ActiveRecord 4.1 columns), and so `alias_method` will not really work. In that
+case you might want to implement your generated method like so:
+
+```ruby
+(respond_to?(:"#{name}_without_increment") ? send(:"#{name}_without_increment") : super()) + 1
+```
+
+In `super()`, the `()` are not needed if you use the `generate_methods`
+(plural) syntax, your arguments will automatically be passed to the parent.
+
+Your user will also be able to override the underlying method like so:
+
+```ruby
+class MyClass
+  attr_accessor :x
+  increment_attr :x
+
+  def x_without_increment
+    super.to_i
+  end
+end
+
+instance = MyClass.new
+instance.x = "123"
+instance.x
+=> 124
+```
+
+`super` will call the original implementation (the one created by
+`attr_accessor`). If you know that implementation, you can skip calling super
+(and use `@x`). If you don't know the implementation (like with ActiveRecord),
+you will probably want to call `super`.
+
+## Contributing
+
+1. Fork it ( https://github.com/odedniv/generate_method/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,2 @@
+require "bundler/gem_tasks"
+

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/generate_method.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generate_method/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "generate_method"
+  spec.version       = GenerateMethod::VERSION
+  spec.authors       = ["Oded Niv"]
+  spec.email         = ["oded.niv@gmail.com"]
+  spec.summary       = %q{Nicely generate methods on a Class or Module.}
+  spec.description   = %q{Allow your gem users to override your generated methods nicely.}
+  spec.homepage      = "https://github.com/odedniv/generate_method"
+  spec.license       = "UNLICENSE"
+
+  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 "rspec", "~> 3.1"
+end

data/lib/generate_method.rb

@@ -0,0 +1,50 @@
+require "generate_method/version"
+
+module GenerateMethod
+  module Generator
+    def generate_method(method_name, overrider: nil, &block)
+      m = Module.new do
+        define_method(method_name, &block)
+      end
+      alias_generated_method(method_name, overrider: overrider, m: m)
+      include m
+    end
+
+    def generate_methods(overrider: nil, &block)
+      m = Module.new(&block)
+      m.instance_methods.each do |method_name|
+        alias_generated_method(method_name, overrider: overrider, m: m)
+      end
+      include m
+    end
+
+    private
+
+    def alias_generated_method(method_name, overrider: nil, m: nil)
+      return if overrider.nil?
+
+      method_name_s, override_name_s = method_name.to_s, overrider.to_s
+      # pushing one of [?=!] to the end of the _without_ method
+      if method_name_s =~ /[\=\?\!]$/
+        override_name_s.concat method_name_s[-1]
+        method_name_s.chop!
+      end
+      override_method_name = :"#{method_name_s}_without_#{override_name_s}"
+
+      begin
+        alias_method :"_#{override_method_name}", method_name
+      rescue NameError # method does not exist
+      else
+        m.instance_eval do
+          define_method(override_method_name) do |*args, &block|
+            send(:"_#{override_method_name}", *args, &block)
+          end
+        end
+      end
+    end
+  end
+end
+
+class Module
+  include GenerateMethod::Generator
+end

data/lib/generate_method/version.rb

@@ -0,0 +1,3 @@
+module GenerateMethod
+  VERSION = "0.0.1"
+end

data/spec/generate_method_spec.rb

@@ -0,0 +1,177 @@
+require 'generate_method'
+
+describe GenerateMethod::Generator do
+  subject(:instance) { klass.new }
+
+  describe "#generate_method" do
+    context "without overrider" do
+      let(:parent) do
+        Class.new do
+          def x?(a, b)
+            "parent#{a}#{b}#{yield}"
+          end
+        end
+      end
+      let(:klass) do
+        Class.new(parent) do
+          generate_method(:x?) { |a, b, &block| super(a, b, &block) + "-generated#{a}#{b}#{block.call}" }
+          def x?(a, b)
+            super + "-sub#{a}#{b}#{yield}"
+          end
+        end
+      end
+
+      it { should_not respond_to(:x_without_override?) }
+      specify { expect(instance.x?(1, 2) { '-block' }).to eq('parent12-block-generated12-block-sub12-block') }
+    end
+
+    context "with overrider" do
+      context "when supports alias" do
+        let(:klass) do
+          Class.new do
+            def x!(a, b)
+              "parent#{a}#{b}#{yield}"
+            end
+            generate_method(:x!, overrider: :override) { |a, b, &block| x_without_override!(a, b, &block) + "-generated#{a}#{b}#{block.call}" }
+            def x!(a, b)
+              super + "-sub#{a}#{b}#{yield}"
+            end
+          end
+        end
+
+        it { should respond_to(:x_without_override!) }
+        specify { expect(instance.x!(1, 2) { '-block' }).to eq('parent12-block-generated12-block-sub12-block') }
+      end
+
+      context "when does not support alias" do
+        let(:parent) do
+          Class.new do
+            def method_missing(method_name, *args, &block)
+              method_name == :x? ? "parent#{args.join}#{yield}" : super
+            end
+          end
+        end
+        let(:klass) do
+          Class.new(parent) do
+            generate_method(:x?, overrider: :override) { |a, b, &block| super(a, b, &block) + "-generated#{a}#{b}#{block.call}" }
+            def x?(a, b)
+              super + "-sub#{a}#{b}#{yield}"
+            end
+          end
+        end
+
+        it { should_not respond_to(:x_without_override?) }
+        specify { expect(instance.x?(1, 2) { '-block' }).to eq('parent12-block-generated12-block-sub12-block') }
+      end
+    end
+  end
+
+  describe "#generate_methods" do
+    context "without overrider" do
+      let(:parent) do
+        Class.new do
+          def x(a, b)
+            "parentx#{a}#{b}#{yield}"
+          end
+          def y(a, b)
+            "parenty#{a}#{b}#{yield}"
+          end
+        end
+      end
+      let(:klass) do
+        Class.new(parent) do
+          generate_methods do
+            def x(a, b)
+              super + "-generatedx#{a}#{b}#{yield}"
+            end
+            def y(a, b)
+              super + "-generatedy#{a}#{b}#{yield}"
+            end
+          end
+          def x(a, b)
+            super + "-subx#{a}#{b}#{yield}"
+          end
+          def y(a, b)
+            super + "-suby#{a}#{b}#{yield}"
+          end
+        end
+      end
+
+      it { should_not respond_to(:x_without_override) }
+      it { should_not respond_to(:y_without_override) }
+      specify { expect(instance.x(1, 2) { '-block' }).to eq('parentx12-block-generatedx12-block-subx12-block') }
+      specify { expect(instance.y(1, 2) { '-block' }).to eq('parenty12-block-generatedy12-block-suby12-block') }
+    end
+
+    context "with overrider" do
+      context "when supports alias" do
+        let(:klass) do
+          Class.new do
+            def x!(a, b)
+              "parentx#{a}#{b}#{yield}"
+            end
+            def y!(a, b)
+              "parenty#{a}#{b}#{yield}"
+            end
+            generate_methods(overrider: :override) do
+              def x!(a, b, &block)
+                x_without_override!(a, b, &block) + "-generatedx#{a}#{b}#{yield}"
+              end
+              def y!(a, b, &block)
+                y_without_override!(a, b, &block) + "-generatedy#{a}#{b}#{yield}"
+              end
+            end
+            def x!(a, b)
+              super + "-subx#{a}#{b}#{yield}"
+            end
+            def y!(a, b)
+              super + "-suby#{a}#{b}#{yield}"
+            end
+          end
+        end
+
+        it { should respond_to(:x_without_override!) }
+        it { should respond_to(:y_without_override!) }
+        specify { expect(instance.x!(1, 2) { '-block' }).to eq('parentx12-block-generatedx12-block-subx12-block') }
+        specify { expect(instance.y!(1, 2) { '-block' }).to eq('parenty12-block-generatedy12-block-suby12-block') }
+      end
+
+      context "when does not support alias" do
+        let(:parent) do
+          Class.new do
+            def method_missing(method_name, *args, &block)
+              case method_name
+                when :x? then "parentx#{args.join}#{yield}"
+                when :y? then "parenty#{args.join}#{yield}"
+                else super
+              end
+            end
+          end
+        end
+        let(:klass) do
+          Class.new(parent) do
+            generate_methods(overrider: :override) do
+              def x?(a, b, &block)
+                super(a, b, &block) + "-generatedx#{a}#{b}#{yield}"
+              end
+              def y?(a, b, &block)
+                super(a, b, &block) + "-generatedy#{a}#{b}#{yield}"
+              end
+            end
+            def x?(a, b)
+              super + "-subx#{a}#{b}#{yield}"
+            end
+            def y?(a, b)
+              super + "-suby#{a}#{b}#{yield}"
+            end
+          end
+        end
+
+        it { should_not respond_to(:x_without_override?) }
+        it { should_not respond_to(:y_without_override?) }
+        specify { expect(instance.x?(1, 2) { '-block' }).to eq('parentx12-block-generatedx12-block-subx12-block') }
+        specify { expect(instance.y?(1, 2) { '-block' }).to eq('parenty12-block-generatedy12-block-suby12-block') }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: generate_method
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oded Niv
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-17 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Allow your gem users to override your generated methods nicely.
+email:
+- oded.niv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- generate_method.gemspec
+- lib/generate_method.rb
+- lib/generate_method/version.rb
+- spec/generate_method_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/odedniv/generate_method
+licenses:
+- UNLICENSE
+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.2
+signing_key: 
+specification_version: 4
+summary: Nicely generate methods on a Class or Module.
+test_files:
+- spec/generate_method_spec.rb
+- spec/spec_helper.rb