itemable 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e027584a4648f266c9f045a25ded47b3d81845b6
+  data.tar.gz: b888279d7af0b65ea947486e53502529ed1b073f
+SHA512:
+  metadata.gz: 427c69a78de009e03fa0052591974a50a76a0cd4f9687ddb5f677af6b2391c122921b25237ef29c3bb911901d9e95a1ffabfae0d8bd4a185e47644051cd14cf7
+  data.tar.gz: b108c8fc19ebf6dc7e6a73b45e2cedf45144ba65b80faea2223482748728452ccbceb107c27b526f989bc0af73baff8ed4a16648848f445953a5b7268f027a93

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 xiaohui
+
+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,171 @@
+# Itemable
+
+Make your ActiveRecord model as a item, it can be child or parent of self-modle or other-model
+
+## When will you need this gem?
+
+Think about you are using PostgreSQL database, you just want to simplely store some unusually-query data into one table, put various files into one jsonb filed, record many have some child records, or parent records, such as a Car has many accessories: 4 Wheels, 3 Chairs, and a Wheel has one Tyre, 5 Screws. I don't care how to store them, just care about their relations, so now let's make this with `Itemable`:
+
+1. Setup `Itemable`
+2. Create Models `Car`, `Wheel`, `Chair`, `Tyre`, `Screw`
+3. Create relations to each model
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'itemable'
+```
+
+And then execute below to create tables `itemable_items` and `itemable_item_relations`:
+
+```bash
+$ rails g itemable:migration
+$ rake db:migrate
+```
+
+## Usage
+
+Create `Car` modle
+
+```
+$ rails g model car name
+```
+
+Update `app/models/car.rb`:
+
+    class Car < ActiveRecord::Base
+        acts_as_itemable
+        has_many_items :wheels, dependent: :destroy
+        has_many_items :chairs, dependent: :destroy
+    end
+
+- `acts_as_itemable` makes `Car` has all feature of `Itemable`  
+- `has_many_items :wheels` declares a car has many wheels  
+- `has_many_items :chairs` declares a car has many chairs  
+
+Create `Wheel` model without db migration:
+
+Add `app/models/wheel.rb`
+
+    class Wheel < ActiveRecord::Base
+        acts_as_itemable sti: true
+        belongs_to_item :car
+        has_many_items :screws, dependent: :destroy
+        has_one_item: :tyre, dependent: :destroy
+    end
+
+- `acts_as_itemable sti: true`, `sti = true` means `Wheel` is a single table inherited Model, will get records from table `itemable_items`
+- `belongs_to_item :car` declares wheel belongs to car
+- `has_one_item: :tyre` declares wheel has only one tyre
+
+Add `app/models/chair.rb`
+
+    class Chair < ActiveRecord::Base
+        acts_as_itemable sti: true
+        belongs_to_item :car
+    end
+
+Add `app/models/tyre.rb`
+
+    class Tyre < ActiveRecord::Base
+        acts_as_itemable sti: true
+        belongs_to_item :wheel
+    end
+
+Add `app/models/screw.rb`
+
+    class Screw < ActiveRecord::Base
+        acts_as_itemable sti: true
+        belongs_to_item :wheel
+    end
+
+**Now everything is ready, let store/query data**
+
+```ruby
+car = Car.create
+4.times do
+    car.wheels << Wheel.create
+end
+3.times do
+    car.chairs << Chair.create
+end
+wheel = Wheel.first
+wheel.tyre = Tyre.create
+5.times do
+    wheel.screws << Screw.create
+end
+
+car.reload
+car.item_children.count => 7
+car.item_children.map(&:child)
+=> [#<Wheel:0x007f86ba65f930 id: 16, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Wheel:0x007f86ba677fa8 id: 17, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Wheel:0x007f86ba685568 id: 18, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Wheel:0x007f86ba69c038 id: 19, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Chair:0x007f86ba6cd0e8 id: 20, type: "Chair", created_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00>,
+ #<Chair:0x007f86ba6e4e28 id: 21, type: "Chair", created_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00>,
+ #<Chair:0x007f86ba706c58 id: 22, type: "Chair", created_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00>]
+car.wheels.count => 4
+=> [#<Wheel:0x007f86c018b8e0 id: 16, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Wheel:0x007f86c018b750 id: 17, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Wheel:0x007f86c018b5c0 id: 18, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>,
+ #<Wheel:0x007f86c018b430 id: 19, type: "Wheel", created_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:18 UTC +00:00>]
+car.chairs.count => 3
+=> [#<Chair:0x007f86be2baab0 id: 20, type: "Chair", created_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00>,
+ #<Chair:0x007f86be2ba830 id: 21, type: "Chair", created_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00>,
+ #<Chair:0x007f86be2ba538 id: 22, type: "Chair", created_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:22 UTC +00:00>]
+wheels = car.wheels
+wheels[0].item_children.count => 6
+wheels[0].item_children.map(&:child)
+=> [#<Tyre:0x007f86be44f290 id: 23, type: "Tyre", created_at: Fri, 07 Apr 2017 04:53:33 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:33 UTC +00:00>,
+ #<Screw:0x007f86be46e0f0 id: 24, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86be47cf60 id: 25, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86be497d38 id: 26, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86be4a6ba8 id: 27, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86be4b59f0 id: 28, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>]
+wheels[0].tyre
+=> #<Tyre:0x007f86b8fb04c8 id: 23, type: "Tyre", created_at: Fri, 07 Apr 2017 04:53:33 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:33 UTC +00:00>
+wheels[0].screws.count => 5
+=> [#<Screw:0x007f86b833c750 id: 24, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86b833c570 id: 25, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86b833c3e0 id: 26, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86b833c250 id: 27, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>,
+ #<Screw:0x007f86b833c0c0 id: 28, type: "Screw", created_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:53:49 UTC +00:00>]
+wheels[1].tyre => nil
+wheels[1].tyre = Tyre.create
+=> #<Tyre:0x007f86bbb8e450 id: 29, type: "Tyre", created_at: Fri, 07 Apr 2017 04:58:05 UTC +00:00, updated_at: Fri, 07 Apr 2017 04:58:05 UTC +00:00>
+wheels[1].item_children.count => 1
+```
+
+See, it's so easy to build model relations
+
+## Advanced Usage
+
+`acts_as_itemable` has following options:
+
+- `sti`: `true` or `false`
+- `children`: `true` or `false`
+    - `true` generates association `item_children`, then support `has_many_items`
+    - `false` does nothing
+- `child`: `true` or `false`
+    - `true` generates association `item_child`, then support `has_one_item`
+    - `false` does nothing
+- `parents`: `true` or `false`
+    - `true` generates association `item_parents`, then support `belongs_to_items`
+    - `false` does nothing
+- `parent`: `true` or `false`
+    - `true` generates association `item_parents`, then support `belongs_to_item`
+    - `false` does nothing
+
+options of `has_many_items`, `has_one_item`, `belongs_to_items`, `belongs_to_item` are the same to `has_many` or `belongs_to`
+
+## Test
+
+    rake
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/itemable/migration.rb

@@ -0,0 +1,15 @@
+module Itemable
+  module Generators
+    module Migration
+      # Implement the required interface for Rails::Generators::Migration.
+      def next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ::ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+    end
+  end
+end

data/lib/generators/itemable/migration_generator.rb

@@ -0,0 +1,16 @@
+require_relative 'migration'
+require_relative 'migration_helper'
+module Itemable
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Itemable::Generators::MigrationHelper
+      extend Itemable::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      def copy_migration
+        migration_template 'create_items.rb', 'db/migrate/create_items.itemable.rb'
+        migration_template 'create_item_relations.rb', 'db/migrate/create_item_relations.itemable.rb'
+      end
+    end
+  end
+end

data/lib/generators/itemable/migration_helper.rb

@@ -0,0 +1,9 @@
+module Itemable
+  module Generators
+    module MigrationHelper
+      def migration_parent
+        Rails::VERSION::MAJOR == 4 ? 'ActiveRecord::Migration' : "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+    end
+  end
+end

data/lib/generators/itemable/templates/create_item_relations.rb

@@ -0,0 +1,10 @@
+class CreateItemRelations < <%= migration_parent %>
+  def change
+    create_table :itemable_item_relations do |t|
+      t.references :parent, polymorphic: true
+      t.references :child, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/itemable/templates/create_items.rb

@@ -0,0 +1,9 @@
+class CreateItems < <%= migration_parent %>
+  def change
+    create_table :itemable_items do |t|
+      t.string :type
+      t.string :name
+      t.timestamps
+    end
+  end
+end

data/lib/itemable.rb

@@ -0,0 +1,6 @@
+module Itemable
+  autoload :ActsAsItemable, 'itemable/acts_as_itemable'
+  autoload :ItemRelation, 'itemable/item_relation'
+end
+
+require 'itemable/railtie' if defined?(Rails)

data/lib/itemable/acts_as_itemable.rb

@@ -0,0 +1,143 @@
+module Itemable
+  module ActsAsItemable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_itemable(sti: false, parents: true, children: true, child: true, parent: true)
+        if sti
+          self.table_name = "itemable_items"
+          self.instance_variable_set('@finder_needs_type_condition', :true)
+        end
+
+        if children
+          include ChildrenAssociation
+          include HasManyItems
+        end
+
+        if child
+          include ChildAssociation
+          include HasOneItem
+        end
+
+        if parents
+          include ParentsAssociation
+          include BelongsToItems
+        end
+
+        if parent
+          include ParentAssociation
+          include BelongsToItem
+        end
+      end
+    end
+
+    module HasManyItems
+      extend ActiveSupport::Concern
+      module ClassMethods
+        def has_many_items(association_name, options={})
+          default_options = {
+            through: :item_children,
+            source: :child,
+            source_type: association_name.to_s.classify
+          }.merge(options.symbolize_keys)
+          if default_options[:dependent] == :destroy
+            before_destroy prepend: true do
+              send(association_name).each do |rec|
+                rec.destroy
+              end
+            end
+          end
+          has_many association_name, default_options
+        end
+      end
+    end
+
+    module HasOneItem
+      extend ActiveSupport::Concern
+      module ClassMethods
+        def has_one_item(association_name, options={})
+          default_options = {
+            through: :item_child,
+            source: :child,
+            source_type: association_name.to_s.classify
+          }.merge(options.symbolize_keys)
+          if default_options[:dependent] == :destroy
+            before_destroy prepend: true do
+              rec = send(association_name)
+              rec.destroy if rec
+            end
+          end
+          has_one association_name, default_options
+        end
+      end
+    end
+
+    module BelongsToItems
+      extend ActiveSupport::Concern
+      module ClassMethods
+        def belongs_to_items(association_name, options={})
+          default_options = {
+            through: :item_parents,
+            source: :parent,
+            source_type: association_name.to_s.classify
+          }
+          has_many association_name, default_options.merge(options.symbolize_keys)
+        end
+      end
+    end
+
+    module BelongsToItem
+      extend ActiveSupport::Concern
+      module ClassMethods
+        def belongs_to_item(association_name, options={})
+          default_options = {
+            through: :item_parent,
+            source: :parent,
+            source_type: association_name.to_s.classify
+          }
+          has_one association_name, default_options.merge(options.symbolize_keys)
+        end
+      end
+    end
+
+    module ChildrenAssociation
+      extend ActiveSupport::Concern
+      included do
+        has_many :item_children,
+                 class_name: 'Itemable::ItemRelation',
+                 as: :parent,
+                 dependent: :destroy
+      end
+    end
+
+    module ChildAssociation
+      extend ActiveSupport::Concern
+      included do
+        has_one :item_child,
+                class_name: 'Itemable::ItemRelation',
+                as: :parent,
+                dependent: :destroy
+      end
+    end
+
+    module ParentsAssociation
+      extend ActiveSupport::Concern
+      included do
+        has_many :item_parents,
+                 class_name: 'Itemable::ItemRelation',
+                 as: :child,
+                 dependent: :destroy
+      end
+    end
+
+    module ParentAssociation
+      extend ActiveSupport::Concern
+      included do
+        has_one :item_parent,
+                 class_name: 'Itemable::ItemRelation',
+                 as: :child,
+                 dependent: :destroy
+      end
+    end
+  end
+end

data/lib/itemable/item_relation.rb

@@ -0,0 +1,7 @@
+module Itemable
+  class ItemRelation < ActiveRecord::Base
+    self.table_name = 'itemable_item_relations'
+    belongs_to :parent, polymorphic: true
+    belongs_to :child, polymorphic: true
+  end
+end

data/lib/itemable/railtie.rb

@@ -0,0 +1,7 @@
+module Itemable
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load(:active_record) do
+      ActiveRecord::Base.send :include, Itemable::ActsAsItemable
+    end
+  end
+end

data/lib/itemable/version.rb

@@ -0,0 +1,3 @@
+module Itemable
+  VERSION = '0.1.1'
+end

data/lib/tasks/itemable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :itemable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: itemable
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- xiaohui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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'
+description: Make your ActiveRecord model to be an item, has polymorphic children
+  and parents.
+email:
+- xiaohui@zhangxh.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/generators/itemable/migration.rb
+- lib/generators/itemable/migration_generator.rb
+- lib/generators/itemable/migration_helper.rb
+- lib/generators/itemable/templates/create_item_relations.rb
+- lib/generators/itemable/templates/create_items.rb
+- lib/itemable.rb
+- lib/itemable/acts_as_itemable.rb
+- lib/itemable/item_relation.rb
+- lib/itemable/railtie.rb
+- lib/itemable/version.rb
+- lib/tasks/itemable_tasks.rake
+homepage: http://github.com/xiaohui-zhangxh/itemable
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Make your ActiveRecord model to be an item, has polymorphic children and
+  parents.
+test_files: []