has_sti 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2d316dd54b23149479449315066fed5a78baf1f
+  data.tar.gz: dc37b2589c3d96ea91695e4d2a98a6624c5a80fc
+SHA512:
+  metadata.gz: cb3ee2e0ffb1ac0ce42f02b85ebdf300e53a17d82172ef33115ab5b4fd2b3770e59976ac9557f3e56082f0de90ce47c3667424a3edfbc0d662621641b77d1a63
+  data.tar.gz: f9d4e63687cb690fbba747accb0b8880bcae9b9328fa7199b2b00ffb98aa5f4e75f5a4259f28c1d4a1bfdceff4ad2e6a20e8eecb734f2962df43a092f1541483

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Arkadiusz Fal
+
+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.rdoc

@@ -0,0 +1,58 @@
+{<img src="https://travis-ci.org/arekf/has_sti.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/arekf/has_sti]
+
+= has_sti
+
++has_sti+ is an ActiveRecord extension that provides helper methods and scopes for STI models.
+
+== Installation
+* Add +has_sti+ to your Gemfile:
+    gem 'has_sti'
+* Install with:
+    bundle install
+
+== Usage
+We will use Ruby on Rails for this scenario. Let's say +User+ model is a parent STI class and you want to create child classes: +Admin+ and +Reader+. You start with defining STI as follows:
+
+     class User < ActiveRecord::Base
+     end
+
+     class Admin < User
+     end
+
+     class Reader < User
+     end
+
+Next step is creating migration for the database:
+    rails generate migration AddTypeToUser type:string
+
+Then, we need to migrate database:
+    bundle exec rake db:migrate
+
+Basic setup of STI is done. Here's where +has_sti+ takes action.
+
+Modify your +User+ model to include +has_sti+:
+
+     class User < ActiveRecord::Base
+         has_sti :admin, :reader
+     end
+
+And that's it. Now you have following methods and scopes available:
+    some_admin = Admin.create
+
+    some_admin.admin? => true
+    some_admin.reader? => false
+
+    User.admin => [some_admin]
+    User.reader => []
+
+No configuration is required. Custom STI column name is supported.
+
+== License
++has_sti+ is released under the MIT license:
+* http://www.opensource.org/licenses/MIT
+
+== Author
+Arkadiusz Fal
+* http://arekf.net
+
+Copyright © 2015

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasSti'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: [:spec]
+
+Bundler::GemHelper.install_tasks
+

data/lib/has_sti/active_record_extensions.rb

@@ -0,0 +1,56 @@
+module HasSti
+  module ActiveRecordExtensions
+    extend ActiveSupport::Concern
+
+    # Creates STI helper methods and scopes. Use it in your parent model, for example:
+    #    class Cat < Animal; end
+    #    class Dog < Animal; end
+    #    class Parrot < Animal; end
+    #
+    #    class Animal < ActiveRecord::Base
+    #        has_sti :cat, :dog, :parrot
+    #    end
+    # Helper methods will be created:
+    #    cat = Cat.first
+    #    cat.cat? => true
+    #    cat.parrot? => false
+    # Also, you can use scopes on parent model, like:
+    #    Animal.cat => array of Cats
+    def has_sti(*klasses)
+      raise HasSti::Exceptions::NoDescendantsError if klasses.count.zero?
+
+      superclass = constant(klasses.first).superclass
+      active_record_superclasses = [ActiveRecord::Base, Object, BasicObject]
+
+      raise HasSti::Exceptions::NoSuperclassError if superclass.nil? || active_record_superclasses.include?(superclass)
+
+      klasses.each do |klass|
+        define_method helper_method_name(klass) do
+          self.class.name == klass.to_s.classify
+        end
+
+        superclass.define_singleton_method scope_method_name(klass) do
+          where(superclass.inheritance_column => class_name(klass))
+        end
+      end
+    end
+
+    private
+
+    def class_name(klass)
+      klass.to_s.classify
+    end
+
+    def constant(klass)
+      class_name(klass).constantize
+    end
+
+    def helper_method_name(klass)
+      "#{klass.to_s.underscore}?"
+    end
+
+    def scope_method_name(klass)
+      klass.to_s.underscore
+    end
+  end
+end

data/lib/has_sti/exceptions.rb

@@ -0,0 +1,14 @@
+module HasSti
+  module Exceptions
+    class NoDescendantsError < StandardError
+      def message
+        'You have not provided STI descendants for has_sti'
+      end
+    end
+    class NoSuperclassError < StandardError
+      def message
+        'Your STI model has no parent model as a superclass'
+      end
+    end
+  end
+end

data/lib/has_sti/version.rb

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

data/lib/has_sti.rb

@@ -0,0 +1,8 @@
+require 'has_sti/active_record_extensions'
+require 'has_sti/exceptions'
+
+module HasSti
+  class ActiveRecord::Base
+    extend HasSti::ActiveRecordExtensions
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: has_sti
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arkadiusz Fal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: has_sti provides helper methods for Single Table Inheritance models of
+  Active Record. It creates methods that allow to determine exact type of model and
+  scopes that make easy to find records of certain type.
+email:
+- me@arekf.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/has_sti.rb
+- lib/has_sti/active_record_extensions.rb
+- lib/has_sti/exceptions.rb
+- lib/has_sti/version.rb
+homepage: http://arekf.net
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Active Record extension that provides helper methods for Single Table Inheritance
+  models
+test_files: []