easily_typable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0221935b88c5cbac4176a0085bd516a6aa2bbec2
+  data.tar.gz: e2a24f81c4e66ddc96bb68a6b2f86dd2532c44f8
+SHA512:
+  metadata.gz: 779755f35a05255d541f1e8d8feddad158922967d830f5cd1867d274f4cc96dbebc734dbb7ec083cc644497f889a50569f92bc728acdefed858956d913ae4641
+  data.tar.gz: c4de309f4db5af0d07f230fda47a3e68001fd45aa3a5f81b572bcc92321d616e57c6b12bb1b0dcd4de98f22447b38a360c28a3de8c73a80503c5a1fe20638b66

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 AndyObtiva
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,103 @@
+# Easily Typable v1.0.0
+[![Gem Version](https://badge.fury.io/rb/easily_typable.svg)](http://badge.fury.io/rb/easily_typable)
+[![Build Status](https://api.travis-ci.org/AndyObtiva/easily_typable.svg?branch=master)](https://travis-ci.org/AndyObtiva/easily_typable)
+[![Coverage Status](https://coveralls.io/repos/AndyObtiva/easily_typable/badge.svg?branch=master)](https://coveralls.io/r/AndyObtiva/easily_typable?branch=master)
+[![Code Climate](https://codeclimate.com/github/AndyObtiva/easily_typable.svg)](https://codeclimate.com/github/AndyObtiva/easily_typable)
+
+## Introduction:
+
+Although polymorphism is a recommended standard in Object-Oriented programming
+for invoking varied behavior in an inheritance hierarchy, sometimes it is still
+useful to verify if a particular model belongs to a certain type when the
+behavior concerned does not belong to the model and is too small to require a
+Design Pattern like Strategy.
+
+A common example in Rails is checking user roles before rendering certain
+parts of the view:
+
+```erb
+<% if user.is_a?(Admin) %>
+  <%= link_to 'Admin', admin_dashboard_path %>
+<% end %>
+```
+
+To avoid the ```model.is_a?(CertainType)``` syntax, a more readable approach
+that developers resort to is to add an English-like method that hides the
+details of type checking ```model.certain_type?```.
+
+The Rails example above would then become:
+
+```erb
+<% if user.admin? %>
+  <%= link_to 'Admin', admin_dashboard_path %>
+<% end %>
+```
+
+Implementing such methods manually gets repetitive after a while, so an easier
+way to get these methods automatically is to mixin the ```EasilyTypable```
+module.
+
+## Example:
+
+```ruby
+require 'easily_typable'
+
+class TypeA
+  include EasilyTypable
+end
+
+class TypeB < TypeA
+end
+
+class TypeC < TypeB
+end
+
+## RSpec of Easily Typable
+require 'spec_helper'
+
+describe EasilyTypable do
+  it "adds type_a? method to TypeA object" do
+    expect(TypeA.new.type_a?).to be_truthy
+  end
+  it "adds type_b? method to TypeA object" do
+    expect(TypeA.new.type_b?).to be_falsey
+  end
+  it "adds type_c? method to TypeA object" do
+    expect(TypeA.new.type_c?).to be_falsey
+  end
+  it "adds type_a? method to TypeB object" do
+    expect(TypeB.new.type_a?).to be_truthy
+  end
+  it "adds type_b? method to TypeB object" do
+    expect(TypeB.new.type_b?).to be_truthy
+  end
+  it "adds type_c? method to TypeB object" do
+    expect(TypeB.new.type_c?).to be_falsey
+  end
+  it "adds type_a? method to TypeC object" do
+    expect(TypeC.new.type_a?).to be_truthy
+  end
+  it "adds type_b? method to TypeC object" do
+    expect(TypeC.new.type_b?).to be_truthy
+  end
+  it "adds type_c? method to TypeC object" do
+    expect(TypeC.new.type_c?).to be_truthy
+  end
+end
+```
+
+## Contributing to Easily Typable
+
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+ * Fork the project.
+ * Start a feature/bugfix branch.
+ * Commit and push until you are happy with your contribution.
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+ * Copyright (c) 2012 - 2017 Andy Maleh
+ * Copyright (c) 2009 - 2011 Andy Maleh - Obtiva Corp.
+ * See LICENSE.txt for further details.

data/lib/easily_typable.rb

@@ -0,0 +1,45 @@
+module EasilyTypable
+
+  def self.included(class_constant)
+    super
+    class_constant.class_eval <<-end_eval
+      def #{__methodize__(class_constant.name)}?
+        self.is_a?(#{class_constant.name})
+      end
+      def self.inherited(subclass_constant)
+        super
+        subclass_constant.send :include, SubClassMethods
+      end
+    end_eval
+  end
+
+  module SubClassMethods
+    def self.included(subclass_constant)
+      super
+      subclass_constant.class_eval(type_method_definition(subclass_constant))
+      superclass_constant = subclass_constant.superclass
+      begin
+        superclass_constant.class_eval(type_method_definition(subclass_constant))
+        superclass_constant = superclass_constant.superclass
+      end while superclass_constant.include?(EasilyTypable)
+    end
+
+    private
+    def self.type_method_definition(subclass_constant)
+      <<-MULTI
+        def #{EasilyTypable::__methodize__(subclass_constant.name)}?
+          self.is_a?(#{subclass_constant.name})
+        end
+      MULTI
+    end
+  end
+
+  protected
+  #added this method to break reliance on ActiveSupport and Facets
+  def self.__methodize__(text)
+    text.gsub(/([A-Z]+)([A-Z])/,'\1_\2').
+    gsub(/([a-z])([A-Z])/,'\1_\2').
+    downcase
+  end
+  
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: easily_typable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- AndyObtiva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+description: Although polymorphism is a recommended standard in Object-Oriented programming
+  for invoking varied behavior in an inheritance hierarchy, sometimes it is still
+  useful to verify if a particular model belongs to a certain type when the behavior
+  concerned does not belong to the model and is too small to require a Design Pattern
+  like Strategy. To avoid the model.is_a?(CertainType) syntax, a more readable approach
+  that developers resort to is to add an English-like method that hides the details
+  of type checking model.certain_type?. Implementing such methods manually gets repetitive
+  after a while, so an easier way to get these methods automatically is to mixin the
+  EasilyTypable module.
+email: andy.am@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/easily_typable.rb
+homepage: http://github.com/AndyObtiva/easily_typable
+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.8
+signing_key: 
+specification_version: 4
+summary: Easier type checking via auto-generated certain_type? methods
+test_files: []