british 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a34dfe5bf9cd65171a44729459b0638c8780cfa5
+  data.tar.gz: b9128cc10357654df255eae4dd625522add3d0b7
+SHA512:
+  metadata.gz: e64fdc3a10c93847b6b5e544ea4ce957b825e3d92878e28614910f52c48fa6ad94fff5863d35590e0bfdcae02dbe7aa250f99417f72fe7cae4134bdb9f18f0c4
+  data.tar.gz: b7987b53f0c8ad135db28d6a2f625779441f4b1dde0810827edab847832d157f29879fc2cf980119fd7cb49440f0e6d35371554d949f5858ea8988e97214f4af

data/lib/british.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+
+# Public: method_missing which tries to call "British" version before failing
+# Could be included to the particular class or globally (monkey-patching Object)
+#
+# Examples
+#
+#   # Create classes with `initialise` constructor (British::Initialisable)
+#   # And magic British methods and attributes (British)
+#   class BritishObject
+#     require 'british'
+#
+#     # use within your objects only *1 …
+#     include British
+#     include British::Initialisable
+#
+#     attr_reader :color
+#
+#     # works exactly like an initialize (including `super` usage)
+#     def initialise(test)
+#       @test = test
+#       @color = 'red'
+#
+#       super('black', 'box', 'arguments')
+#     end
+#
+#     def magnetize(test)
+#       @test
+#     end
+#   end
+#
+#   british_object = BritishObject.new('Hello UK!')
+#   british_object.test # => 'Hello UK!'
+#
+#   # Use British endings with any method or attribute
+#   british_object.colour    # => "red"
+#   british_object.magnetise # => "Hello UK!"
+#
+#   # *1 … patch third party or all the system Objects
+#   String.include British
+#   'cheers!'.capitalise # => "Cheers!"
+#
+#   require 'active_support/inflector'
+#   include British
+#
+#   # Use is_an? with classes like an Array!
+#   [].is_an? Array # => true
+#
+#   'cheers!'.capitalise # => "Cheers!"
+#   'oi_ya_bloody_wanker'.camelise # => "OiYaBloodyWanker"
+module British
+  # Public: Hash of British ↔ American words endings
+  ENDINGS = {
+    # Latin-derived spellings
+    'our'  => 'or',
+    're'   => 'er',
+    'ce'   => 'se',
+    'xion' => 'ction',
+
+    # Greek-derived spellings
+    'ise'     => 'ize',
+    'isation' => 'ization',
+    'yse'     => 'yze',
+    'ogue'    => 'og'
+  }
+
+  # Public: Submodule to be included in your own classes to use `initialise`
+  #
+  # As far as `initialize` called automatically by a `new` method there is no
+  # sense to use it for third party classes.
+  #
+  module Initialisable
+    # Public: On module being included do:
+    #   1. Check if it's a global include
+    #   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.
+    def self.included(host_class)
+      unless host_class == Object
+        # alias parent's initialise method
+        host_class.superclass.class_eval do
+          alias_method :initialise, :initialize
+        end
+
+        # create own initialize method
+        define_method :initialize do |*args|
+          initialise(*args)
+        end
+      end
+    end
+  end
+
+  # Public: British alias of native is_a? method
+  # Returns the original method's result
+  def is_an?(*args)
+    is_a?(*args) if self.respond_to?(:is_a?)
+  end
+
+  # Public: additional alias for is_an?/is_a? method
+  alias_method :an?, :is_an?
+
+  # Public: Magic method which tries to translate British methods to American
+  # methods before throwing NoMethodError if neither method was found.
+  #
+  #   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 age 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
+  # Raises NoMethodError if the method cannot be found.
+  def method_missing(name, *args)
+    name = name.to_s
+
+    ENDINGS.each_pair do |bre_e, ame_e|
+      next unless name.include?(bre_e)
+
+      british_ending_pattern = /#{bre_e}(?=_|-|$|\?|\!|=)/
+      americanised_name = name.gsub(british_ending_pattern, ame_e)
+
+      return send(americanised_name, *args) if respond_to?(americanised_name)
+    end
+
+    fail NoMethodError, "undefined method `#{name}' for #{self}"
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: british
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serge Bedzhyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 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
+  your classes.'
+email: smileart21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/british.rb
+homepage: https://github.com/smileart/british
+licenses:
+- MIT
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A tiny module that is supposed to help Brits to use Ruby with more comfort.
+test_files: []
+has_rdoc: