british 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2de5cefa81b5c10cf76b3021b29272e9eedcc8fc
-  data.tar.gz: 1c29c1ac92f4e2a4e6ef21fc527d4d1068850c8c
+  metadata.gz: ca12a1028d620d5acb7449788a9cc4cd9d687c6e
+  data.tar.gz: abf7dc891caacbaa8af865505b4239cb3cbe0c57
 SHA512:
-  metadata.gz: 6924d0a0f859e41404787bf4d52298bb006f1977662e52269241d206bcd7fcabe1cd3367064bc65cc8ba05be61b9b50020b9e3e81046dae48c5f72f6435b62b9
-  data.tar.gz: 0e743a804a051fa72490c1b134192fa7dc5aea33e829d830d49dbd0956bac635dc9a154f8389476dd998e66cbca1069adbfcd941116824ff765b6ada1cc276fa
+  metadata.gz: a3cddb6ed91db752f4a1732af9532627cfe0ce08b51126e10a625a2e86fab01a4217b9da0f73c57e0646e40d4a6dc8c1dfac0fb8ba763bc8992314d68e0aabe8
+  data.tar.gz: 212803711ca2b2f0a86ff3c714843d244b214e97cf8a8b2da01d5d005c7736c3fa221716d8fea69f325d0c9f786f3101753cf800602d60b085db5214afcb57c7

data/lib/british.rb

@@ -78,7 +78,14 @@ module British
     #   2. Add and alias of the parent's `initialize` (for `super` calls)
     #   3. Create your own initialize method (to be auto-called by the `new`)
     #
-    # Returns nothing.
+    # Warning
+    #   By including this module you redefine your initialiZe method.
+    #   Use initialiSe method instead of the original, but not both!
+    #
+    # Example:
+    #   include British::Initialisable
+    #
+    # Returns nothing
     def self.included(host_class)
       unless host_class == Object
         # alias parent's initialise method
@@ -86,10 +93,19 @@ module British
           alias_method :initialise, :initialize
         end
 
-        # create own initialize method
+        # suppress 'method redefined; discarding old initialize' warning
+        # https://goo.gl/PSzrbF ¯\_(ツ)_/¯
+        verbose = $VERBOSE
+        $VERBOSE = nil
+
+        # Once again: since we use this Initialisable module in our classes
+        # ONLY, and create our own initialiSe method, we can't break anything
+        # by redefining initialiZe
         define_method :initialize do |*args|
           initialise(*args)
         end
+
+        $VERBOSE = verbose
       end
     end
   end
@@ -98,36 +114,80 @@ module British
   alias is_an? is_a?
   alias an? is_an?
 
+  # Hook to be called when British module being included
+  # Add method_missing method with all the British 'magic' behaviour
+  # Extends a class to make it British
+  #
+  # Example:
+  #
+  #   class Example
+  #      include British
+  #
+  #      def color
+  #         'red'
+  #      end
+  #   end
+  #
+  #   example = Example.new
+  #   example.colour # => "red"
+  #
+  # Returns nothing
   def self.included(host_class)
     host_class.extend ClassMethods
-    host_class.overwrite_method_missing
+    host_class.class_overwrite_method_missing
 
     host_class.instance_eval do
       def method_added(name)
-        return if name != :method_missing
-        overwrite_method_missing
+        class_overwrite_method_missing if name == :method_missing
       end
     end
   end
 
-  # Public: ClassMethods to extend in self.included
+  # Hook to be called when British module being used to extend an object
+  # Add method_missing method with all the British 'magic' behaviour
+  # Extends an object instance to make it British
+  #
+  # Example:
+  #
+  #   not_british = SomeClass.new # with color method
+  #   refugee = SomeClass.new # with color method
+  #
+  #   # Make it British
+  #   british = refugee.extend(British)
+  #
+  #   not_british.colour # undefined method `colour'
+  #   british.colour # works well
+  #
+  # Returns nothing
+  def self.extended(host_object)
+    host_object.extend ClassMethods
+    host_object.object_overwrite_method_missing
+
+    host_object.instance_eval do
+      def singleton_method_added(name)
+        object_overwrite_method_missing if name == :method_missing
+      end
+    end
+  end
+
+  # Public: ClassMethods to extend in self.included/self.extended
   # Defines an?, is_an?, method_missing
   module ClassMethods
-
-    # Public: method to overwrite original method_missing with magic one:
+    # Public: method to overwrite original method_missing with a magic one:
     # this method_missing tries to translate British methods to American
-    # ones before throwing NoMethodError if neither method was found.
+    # ones before throwing NoMethodError if neither method was found. Works
+    # on a class level.
     #
     #   name - original method name
     #   *args - original method args
     #
-    # Example
+    # Example:
     #
     #   # with any British object
     #   british_object.colour    # will be translated into color
     #   british_object.magnetise # will be translated into magnetize
     #
-    #   # all method endings age allowed
+    #   # all method endings are allowed
     #   british_object.surprize!
     #   british_object.surprize?
     #   british_object.surprize=
@@ -138,10 +198,11 @@ module British
     # Returns the original method's result
     # Calls original method_missing (if British didn't hook anything)
     # Raises NoMethodError if the method cannot be found
-    def overwrite_method_missing
+    def class_overwrite_method_missing
       class_eval do
         unless method_defined?(:british_method_missing)
           define_method(:british_method_missing) do |name, *args|
+
             # do British magic
             americanised_name = name.to_s.gsub(BRITISH_ENDING_PATTERN, ENDINGS)
             return send(americanised_name, *args) if respond_to?(americanised_name)
@@ -161,5 +222,51 @@ module British
         end
       end
     end
+
+    # Public: method to overwrite original method_missing with a magic one:
+    # this method_missing tries to translate British methods to American
+    # ones before throwing NoMethodError if neither method was found. Works
+    # on an instance level.
+    #
+    #   name - original method name
+    #   *args - original method args
+    #
+    # Example:
+    #
+    #   # with any British object
+    #   british_object.colour    # will be translated into color
+    #   british_object.magnetise # will be translated into magnetize
+    #
+    #   # all method endings are allowed
+    #   british_object.surprize!
+    #   british_object.surprize?
+    #   british_object.surprize=
+    #
+    #   # complex names are supported
+    #   british_object.initialise_something # initialize_something will be called
+    #
+    # Returns the original method's result
+    # Calls original method_missing (if British didn't hook anything)
+    # Raises NoMethodError if the method cannot be found
+    def object_overwrite_method_missing
+      instance_eval do
+        unless respond_to?(:british_method_missing)
+          def british_method_missing(name, *args)
+            $stdout.flush
+            # do British magic
+            americanised_name = name.to_s.gsub(BRITISH_ENDING_PATTERN, ENDINGS)
+            return send(americanised_name, *args) if respond_to?(americanised_name)
+
+            # call original method_missing (avoid double original method calls)
+            return original_method_missing(name, *args) if caller[0] !~ /method_missing/ && defined?(:original_method_missing)
+          end
+        end
+
+        if method(:method_missing) != method(:british_method_missing)
+          alias :original_method_missing :method_missing
+          alias :method_missing :british_method_missing
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: british
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Serge Bedzhyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies: []
 description: 'Allows to use alternative words endings: -ise instead of -ize etc. Defines
   `is_an?` as an alias of the is_a? method. Provides module to use `initialise` in
@@ -39,7 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A tiny module that is supposed to help Brits to use Ruby with more comfort