mabbre 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5db2c5a298a84213898b57446f49f5f19f010b0
-  data.tar.gz: 1398a1fc8fef6a48ebfc1639674c3bf88369ec13
+  metadata.gz: c016656016fd3c08ce23dfa62e5c13068d7ad20d
+  data.tar.gz: 543dfd9db25ba624fa8f7a5295313b624ec9c347
 SHA512:
-  metadata.gz: 98edd86d51eed250ee24289b614e4b986aaae0f6b2c22d40eba048cca89849050e6b6802d7169dcbe82e259fe634cfdd57c75ee193604d8898d90f3c5a7afca1
-  data.tar.gz: 2e1e614d03708c085c1dc5b4de9765ce677c8217344ae2ad636f2ae1a23a49d030bcf38bba157e5b4770a103da2e9b3581f132b1fcacd82b3c0bc05c0656b6ec
+  metadata.gz: 08ff8ad423c2967b4eef88c51450533917cb3adcf570d66a87406256d2e9a928af095e46ffa311f9996f87d82f57e2fd4818d329b5eef7e6dec55c5e3f5de7ae
+  data.tar.gz: 98a2a1222e1e7dbd2544f29f8b5adabea5d4860322277bc58b5b9264ea2ebaee7a131ced8fb4c173246fd856b87678daedf632b68f4e788394d4cc6cea0d4732

data/.rubocop.yml

@@ -1,5 +1,7 @@
 Metrics/LineLength:
   Max: 120
+Style/AndOr:
+  EnforcedStyle: conditionals
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 Style/SpaceInsideBlockBraces:

data/README.md

@@ -36,6 +36,8 @@ Or install it yourself as:
 Step 1: Define methods within an `allow_abbreviated` block in a Class or a Module:
 
 ```ruby
+require "mabbre"
+
 module M
   extend MAbbre::Mixin
   allow_abbreviated do

data/lib/mabbre/compatibility.rb

@@ -0,0 +1,49 @@
+module MAbbre # rubocop:disable Style/Documentation
+  ##
+  # This is a temporary module that is run when loading MAbbre in order to add patches on some Ruby
+  # versions/implementations. After the environment is patched it will be automatically removed.
+  module Compatibility
+    ##
+    # Relative path to the directory where patch files for the Object class live.
+    PATH_TO_OBJECT_PATCHES = "mabbre/patch/object_mixin".freeze
+
+    ##
+    # A hash of patch names for the Object class. Each patch name has a +true+ or +false+ value assigned that represents
+    # if they need to be applied or not.
+    OBJECT_PATCHES = {
+      :respond_to_missing => !Object.private_instance_methods.map(&:to_sym).include?(:respond_to_missing?)
+    }.freeze
+
+    class << self
+      private
+
+      ##
+      # call-seq:
+      #   init_self() => nil
+      #
+      # This method is automatically called by this module in order to apply all patches.
+      #
+      # Returns a +nil+ value.
+      def init_self
+        check_object
+        nil
+      end
+
+      ##
+      # call-seq:
+      #   check_object() => Object or nil
+      #
+      # Checks all available patches for the Object class and applies the ones that are needed.
+      #
+      # Returns Object if patches were applied or +nil+ otherwise.
+      def check_object
+        OBJECT_PATCHES.each {|patch, needed| require "#{PATH_TO_OBJECT_PATCHES}/#{patch}" if needed }
+        Object.instance_eval { include Patch::ObjectMixin } if OBJECT_PATCHES.values.any?
+      end
+    end
+
+    init_self
+  end
+
+  remove_const :Compatibility
+end

data/lib/mabbre/interpreter.rb

@@ -19,5 +19,17 @@ module MAbbre
         super
       end
     end
+
+    ##
+    # call-seq:
+    #   respond_to_missing?(name, include_all) => true or false
+    #
+    # Checks if this object responds to abbreviation +name+. The +include_all+ parameter is not used but it will
+    # be passed to +super+ if no suitable candidate is found.
+    #
+    # Returns +true+ if this object responds to +name+, or whatever +super+ returns otherwise.
+    def respond_to_missing?(name, include_all)
+      self.class.tracked_methods(MAbbre).one? {|m| m.to_s =~ /\A#{name}/ } or super
+    end
   end
 end

data/lib/mabbre/patch/object_mixin/respond_to_missing.rb

@@ -0,0 +1,36 @@
+module MAbbre
+  ##
+  # Contains all compatibility patches that may be added to the environment depending on the current Ruby
+  # version/implementation. This module won't be defined in an environment were no patches were applied.
+  module Patch
+    ##
+    # Contains all patches related to the Object class. The methods contained within will only be defined if they are
+    # needed.
+    module ObjectMixin
+      ##
+      # call-seq:
+      #   respond_to?(name, include_all = false) => true or false
+      #
+      # Passes +name+ and +include_all+ to +super+, and if +false+ is returned then #respond_to_missing? will be
+      # called.
+      #
+      # Returns +true+ if this object responds to +name+, and +false+ otherwise.
+      def respond_to?(name, include_all = false)
+        super or respond_to_missing?(name, include_all)
+      end
+
+      private
+
+      ##
+      # call-seq:
+      #   respond_to_missing?(name, include_all) => false
+      #
+      # This is used as the base implementation of #respond_to_missing?.
+      #
+      # Returns +false+ irregardless of the value of +name+ and +include_all+.
+      def respond_to_missing?(_name, _include_all)
+        false
+      end
+    end
+  end
+end

data/lib/mabbre/version.rb

@@ -35,5 +35,5 @@
 module MAbbre
   ##
   # Current version of MAbbre.
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mabbre.rb

@@ -1,2 +1,3 @@
+require "mabbre/compatibility"
 require "mabbre/mixin"
 require "mabbre/version"

data/mabbre.gemspec

@@ -8,8 +8,13 @@ Gem::Specification.new do |spec|
   spec.version       = MAbbre::VERSION
   spec.authors       = ["Gabriel de Oliveira"]
   spec.email         = ["deoliveira.gab@gmail.com"]
-  spec.summary       = "Write a short summary. Required."
-  spec.description   = "Write a longer description. Optional."
+  spec.summary       = "Enable shortened method names on classes and modules."
+  spec.description   = <<-EOS.strip.gsub(/\n/, "").gsub(/\s{2,}/, " ")
+                         MAbbre allows a group of methods in a Class or a
+                         Module to be accessed using an abbreviated form.
+                         These methods can be defined anywhere within a
+                         hierarchy of inclusion and/or inheritance.
+                       EOS
   spec.homepage      = "https://github.com/gdeoliveira/mabbre"
   spec.license       = "MIT"
 
@@ -17,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "mtrack", "~> 1.1.0"
+  spec.add_dependency "mtrack", "~> 1.1"
 end

data/spec/lib/mabbre/mixin_spec.rb

@@ -150,29 +150,6 @@ describe MAbbre::Mixin do
                                                                 :meth_11_extra, :meth_12_extra, :meth_13_extra,
                                                                 :meth_21_extra, :meth_22_extra, :meth_23_extra])
       end
-
-      describe "instance" do
-        subject { super_class.new }
-
-        it "avoids calling ambiguous methods" do
-          expect { subject.meth }.to raise_error(NoMethodError)
-          expect { subject.meth_0 }.to raise_error(NoMethodError)
-          expect { subject.meth_1 }.to raise_error(NoMethodError)
-          expect { subject.meth_2 }.to raise_error(NoMethodError)
-        end
-
-        it "calls resolvable methods that can be abbreviated" do
-          expect(subject.meth_01).to be(:meth_01_extra)
-          expect(subject.meth_12).to be(:meth_12_extra)
-          expect(subject.meth_23).to be(:meth_23_extra)
-        end
-
-        it "avoids calling resolvable methods that can't be abbreviated" do
-          expect { subject.meth_00 }.to raise_error(NoMethodError)
-          expect { subject.meth_10 }.to raise_error(NoMethodError)
-          expect { subject.meth_20 }.to raise_error(NoMethodError)
-        end
-      end
     end
 
     context "sub class" do
@@ -188,6 +165,8 @@ describe MAbbre::Mixin do
       describe "instance" do
         subject { sub_class.new }
 
+        it { should_not respond_to(:meth, :meth_0, :meth_1, :meth_2, :meth_3) }
+
         it "avoids calling ambiguous methods" do
           expect { subject.meth }.to raise_error(NoMethodError)
           expect { subject.meth_0 }.to raise_error(NoMethodError)
@@ -196,6 +175,8 @@ describe MAbbre::Mixin do
           expect { subject.meth_3 }.to raise_error(NoMethodError)
         end
 
+        it { should respond_to(:meth_01, :meth_12, :meth_23, :meth_31) }
+
         it "calls resolvable methods that can be abbreviated" do
           expect(subject.meth_02).to be(:meth_02_extra)
           expect(subject.meth_13).to be(:meth_13_extra)
@@ -203,6 +184,8 @@ describe MAbbre::Mixin do
           expect(subject.meth_32).to be(:meth_32_extra)
         end
 
+        it { should_not respond_to(:meth_00, :meth_10, :meth_20, :meth_30) }
+
         it "avoids calling resolvable methods that can't be abbreviated" do
           expect { subject.meth_09 }.to raise_error(NoMethodError)
           expect { subject.meth_19 }.to raise_error(NoMethodError)

data/spec/lib/mabbre/patch/object_mixin/respond_to_missing_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "mabbre/patch/object_mixin/respond_to_missing"
+
+describe MAbbre::Patch::ObjectMixin do
+  subject do
+    dc = described_class
+    Class.new.instance_eval { include dc }.new
+  end
+
+  describe "#respond_to?" do
+    it "calls #respond_to_missing? at least once" do
+      expect(subject).to receive(:respond_to_missing?).with(:test_method, false).at_least(:once)
+      subject.respond_to? :test_method
+    end
+
+    it "calls #respond_to_missing? at most twice" do
+      expect(subject).to receive(:respond_to_missing?).with(:test_method, false).at_most(:twice)
+      subject.respond_to? :test_method
+    end
+  end
+
+  describe "#respond_to_missing?" do
+    it "returns false" do
+      expect(subject.send(:respond_to_missing?, :test_method, true)).to be(false)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mabbre
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gabriel de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mtrack
@@ -16,15 +16,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
-description: Write a longer description. Optional.
+        version: '1.1'
+description: MAbbre allows a group of methods in a Class or a Module to be accessed
+  using an abbreviated form. These methods can be defined anywhere within a hierarchy
+  of inclusion and/or inheritance.
 email:
 - deoliveira.gab@gmail.com
 executables: []
@@ -41,13 +43,16 @@ files:
 - README.md
 - Rakefile
 - lib/mabbre.rb
+- lib/mabbre/compatibility.rb
 - lib/mabbre/extension.rb
 - lib/mabbre/interpreter.rb
 - lib/mabbre/mixin.rb
+- lib/mabbre/patch/object_mixin/respond_to_missing.rb
 - lib/mabbre/version.rb
 - mabbre.gemspec
 - spec/.rubocop.yml
 - spec/lib/mabbre/mixin_spec.rb
+- spec/lib/mabbre/patch/object_mixin/respond_to_missing_spec.rb
 - spec/lib/mabbre/version_spec.rb
 - spec/spec_helper.rb
 - tasks/console.rb
@@ -75,9 +80,10 @@ rubyforge_project:
 rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
-summary: Write a short summary. Required.
+summary: Enable shortened method names on classes and modules.
 test_files:
 - spec/.rubocop.yml
 - spec/lib/mabbre/mixin_spec.rb
+- spec/lib/mabbre/patch/object_mixin/respond_to_missing_spec.rb
 - spec/lib/mabbre/version_spec.rb
 - spec/spec_helper.rb