garland 0.13 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 885af5d90937a16db08d2dee34529e2d6607bb79
-  data.tar.gz: 7c92f361a8e2dca83024d94f5fb0c36201df9266
+  metadata.gz: 6acc1a7f250514377aac16a344919064b6aa5a4e
+  data.tar.gz: a628e61d15c72b9959ee18e0eef57dbe0ffb5255
 SHA512:
-  metadata.gz: 8637428a718c2e83e05347d11c3653ecd61dbe920fa93c5644bfb1ed610a1eace2d69ec29fb0bcdc977150c16d7b523b64c825a6090e5a6e7d21b1efe482ef80
-  data.tar.gz: e876fa3d283f577b1006889aeda5119301c0b2e73a833255a914380616786de054d02399f800be52552366d7961145dc6d198aa111338c7e3018466724f8f379
+  metadata.gz: 5924e559189b60bf41146286c428ad23ca9826a40c46ac44dc5502c1b0a3a99c345454413d1f8c79720ea9cd8bfc74b05a37135fb17db700e4eb76d8aa92d684
+  data.tar.gz: c94774db93f0b55a547f432ea062d476b2af5c660778b65820693a8c6cec1892e1bbbc70ef3296a396d81ec2a32e9220cafefc668e39bcde1abf963a87f6d273

data/lib/garland_rails.rb

@@ -19,7 +19,7 @@ module GarlandRails
 
         belongs_to_type = self.name
         scope = -> { where(belongs_to_type: belongs_to_type) }
-        options = options.merge({ foreign_key: "belongs_to_id" })
+        options = options.merge(foreign_key: "belongs_to_id")
       end
 
       super(name, scope, options, &extension)
@@ -37,8 +37,8 @@ module GarlandRails
     validates_uniqueness_of :type, scope: [
       :belongs_to_id,
       :belongs_to_type,
-      :next,
-    ], conditions: -> { where("next IS NULL OR previous IS NULL") }
+      :next_id,
+    ], conditions: -> { where("next_id IS NULL OR previous_id IS NULL") }
 
     # everything seems to work without `polymorphic: true`,
     # but we will set it just for accordance to docs
@@ -47,7 +47,7 @@ module GarlandRails
         options = scope
         scope = nil
       end
-      options = options.merge({ foreign_key: "belongs_to_id" })
+      options = options.merge(foreign_key: "belongs_to_id")
 
       super(name, scope, options, &extension)
     end
@@ -62,8 +62,8 @@ module GarlandRails
         belongs_to = args[:belongs_to]
         if belongs_to
           belongs_to_params = self._split_belongs_to(belongs_to)
-          belongs_to_id = belongs_to_params[:belongs_to_id]
-          belongs_to_type = belongs_to_params[:belongs_to_type]
+          belongs_to_id, belongs_to_type =
+            belongs_to_params.values_at(:belongs_to_id, :belongs_to_type)
         end
       else
         hash = args
@@ -94,17 +94,17 @@ module GarlandRails
     end
 
     def self.tail(belongs_to = nil)
-      self.thread(belongs_to).find_by(previous: nil)
+      self.thread(belongs_to).find_by(previous_id: nil)
     end
 
     def self.head(belongs_to = nil)
-      self.thread(belongs_to).find_by(next: nil)
+      self.thread(belongs_to).find_by(next_id: nil)
     end
 
     def self.last_diff(belongs_to = nil)
       head = self.head(belongs_to)
 
-      self.find_by(id: head.previous)
+      self.find_by(id: head.previous_id)
     end
 
     def self.table_type(record)
@@ -118,14 +118,14 @@ module GarlandRails
     def self.init(hash, belongs_to = nil)
       common_props = self._split_belongs_to(belongs_to)
 
-      tail_props = common_props.merge({ entity: {}.to_s, entity_type: SNAPSHOT })
+      tail_props = common_props.merge(entity: {}.to_s, entity_type: SNAPSHOT)
       brand_new_tail = self.new(tail_props)
 
       diff = HashDiffSym.diff({}, hash)
-      first_diff_props = common_props.merge({ entity: diff.to_s, entity_type: DIFF })
+      first_diff_props = common_props.merge(entity: diff.to_s, entity_type: DIFF)
       first_diff = self.new(first_diff_props)
 
-      head_props = common_props.merge({ entity: hash.to_s, entity_type: SNAPSHOT })
+      head_props = common_props.merge(entity: hash.to_s, entity_type: SNAPSHOT)
       brand_new_head = self.new(head_props)
 
       self.transaction do
@@ -144,10 +144,10 @@ module GarlandRails
          # here and below validations may be skipped as long as we check for continuity later
          brand_new_head.save(validate: false)
          first_diff.save(validate: false)
-         brand_new_tail.update_attribute(:next, first_diff.id)
-         first_diff.update_attribute(:previous, brand_new_tail.id)
-         first_diff.update_attribute(:next, brand_new_head.id)
-         brand_new_head.update_attribute(:previous, first_diff.id)
+         brand_new_tail.update_attribute(:next_id, first_diff.id)
+         first_diff.update_attribute(:previous_id, brand_new_tail.id)
+         first_diff.update_attribute(:next_id, brand_new_head.id)
+         brand_new_head.update_attribute(:previous_id, first_diff.id)
 
          unless self.continuous?(belongs_to)
            Rails.logger.error("Initialized garland is not continuous")
@@ -162,18 +162,18 @@ module GarlandRails
 
     def self.insert_diff(hash, belongs_to = nil)
       head = self.head(belongs_to)
-      last_diff = self.find_by(id: head.previous)
+      last_diff = self.find_by(id: head.previous_id)
       common_props = self._split_belongs_to(belongs_to)
 
       diff = HashDiffSym.diff(eval(head.entity), hash)
       return unless diff.any?
 
-      new_diff_props = common_props.merge({
+      new_diff_props = common_props.merge(
         entity: diff.to_s,
         entity_type: DIFF,
-        previous: last_diff.id,
-        next: head.id,
-      })
+        previous_id: last_diff.id,
+        next_id: head.id,
+      )
       new_diff = self.new(new_diff_props)
 
       self.transaction do
@@ -187,17 +187,17 @@ module GarlandRails
            return nil
          end
 
-         last_diff.next = new_diff.id
+         last_diff.next_id = new_diff.id
          unless last_diff.save
-           Rails.logger.error("Unable to save last_diff with 'next' = '#{new_diff.id}'")
+           Rails.logger.error("Unable to save last_diff with 'next_id' = '#{new_diff.id}'")
            ActiveRecord::Base.connection.exec_rollback_to_savepoint("savepoint_before_insert_diff")
            ActiveRecord::Base.connection.release_savepoint("savepoint_before_init")
            return nil
          end
 
-         head.previous = new_diff.id
+         head.previous_id = new_diff.id
          unless head.save
-           Rails.logger.error("Unable to save head with 'previous' = '#{new_diff.id}'")
+           Rails.logger.error("Unable to save head with 'previous_id' = '#{new_diff.id}'")
            ActiveRecord::Base.connection.exec_rollback_to_savepoint("savepoint_before_insert_diff")
            ActiveRecord::Base.connection.release_savepoint("savepoint_before_init")
            return nil
@@ -205,7 +205,7 @@ module GarlandRails
 
          head.entity = hash.to_s
          unless head.save
-           Rails.logger.error("Unable to save head with 'entity' = '#{hash.to_s}'")
+           Rails.logger.error("Unable to save head with 'entity' = '#{hash}'")
            ActiveRecord::Base.connection.exec_rollback_to_savepoint("savepoint_before_insert_diff")
            ActiveRecord::Base.connection.release_savepoint("savepoint_before_init")
            return nil
@@ -223,9 +223,9 @@ module GarlandRails
       current_bulb = tail
       current_hash = eval(tail.entity)
       items_counted = 1
-      while current_bulb.next do
+      while current_bulb.next_id do
         items_counted += 1
-        current_bulb = self.find_by(id: current_bulb.next)
+        current_bulb = self.find_by(id: current_bulb.next_id)
         if current_bulb.entity_type == DIFF
           current_hash = HashDiffSym.patch!(current_hash, eval(current_bulb.entity))
         else

data/lib/generators/garland_rails/install_generator.rb

@@ -0,0 +1,35 @@
+# Based on
+# https://github.com/huacnlee/rails-settings-cached/blob/master/lib/generators/settings/install_generator.rb
+# by Jason "huacnlee" Lee.
+require "rails/generators"
+require "rails/generators/migration"
+
+module GarlandRails
+  # TODO: DRY
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Generate Garland files.'
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    @@migrations = false
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        if @@migrations
+          (current_migration_number(dirname) + 1)
+        else
+          @@migrations = true
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        end
+      else
+        format '%.3d', current_migration_number(dirname) + 1
+      end
+    end
+
+    def create_migration_file
+      source = "install_migration.rb"
+      destination = "db/migrate/install_garland.rb"
+      migration_template source, destination
+    end
+  end
+end

data/lib/generators/garland_rails/templates/install_migration.rb

@@ -0,0 +1,14 @@
+class InstallGarland < ActiveRecord::Migration[5.0]
+  def change
+    create_table :garlands do |t|
+      t.text :entity, null: false
+      t.boolean :entity_type, null: false
+      t.integer :previous
+      t.integer :next
+      t.integer :belongs_to_id
+      t.string :belongs_to_type
+      t.string :type
+      t.timestamps
+    end
+  end
+end

data/lib/generators/garland_rails/templates/uninstall_migration.rb

@@ -0,0 +1,5 @@
+class UninstallGarland < ActiveRecord::Migration[5.0]
+  def change
+    drop_table :garlands
+  end
+end

data/lib/generators/garland_rails/templates/v0_to_v1_migration.rb

@@ -0,0 +1,6 @@
+class GarlandV0ToV1 < ActiveRecord::Migration[5.0]
+  def change
+    rename_column :garlands, :next, :next_id
+    rename_column :garlands, :previous, :previous_id
+  end
+end

data/lib/generators/garland_rails/uninstall_generator.rb

@@ -0,0 +1,35 @@
+# Based on
+# https://github.com/huacnlee/rails-settings-cached/blob/master/lib/generators/settings/install_generator.rb
+# by Jason "huacnlee" Lee.
+require "rails/generators"
+require "rails/generators/migration"
+
+module GarlandRails
+  # TODO: DRY
+  class UninstallGenerator < Rails::Generators::Base
+    desc 'Generate Garland files.'
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    @@migrations = false
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        if @@migrations
+          (current_migration_number(dirname) + 1)
+        else
+          @@migrations = true
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        end
+      else
+        format '%.3d', current_migration_number(dirname) + 1
+      end
+    end
+
+    def create_migration_file
+      source = "uninstall_migration.rb"
+      destination = "db/migrate/uninstall_garland.rb"
+      migration_template source, destination
+    end
+  end
+end

data/lib/generators/garland_rails/upgrade_generator.rb

@@ -0,0 +1,35 @@
+# Based on
+# https://github.com/huacnlee/rails-settings-cached/blob/master/lib/generators/settings/install_generator.rb
+# by Jason "huacnlee" Lee.
+require "rails/generators"
+require "rails/generators/migration"
+
+module GarlandRails
+  # TODO: DRY
+  class UpgradeGenerator < Rails::Generators::NamedBase
+    desc 'Upgrades Garland db.'
+    include Rails::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    @@migrations = false
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        if @@migrations
+          (current_migration_number(dirname) + 1)
+        else
+          @@migrations = true
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        end
+      else
+        format '%.3d', current_migration_number(dirname) + 1
+      end
+    end
+
+    def create_migration_file
+      source = "#{file_name}_migration.rb"
+      destination = "db/migrate/upgrade_garland_#{file_name}.rb"
+      migration_template source, destination
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garland
 version: !ruby/object:Gem::Version
-  version: '0.13'
+  version: '1.0'
 platform: ruby
 authors:
 - Alexander Morozov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashdiff_sym
@@ -33,6 +33,12 @@ extra_rdoc_files: []
 files:
 - lib/garland.rb
 - lib/garland_rails.rb
+- lib/generators/garland_rails/install_generator.rb
+- lib/generators/garland_rails/templates/install_migration.rb
+- lib/generators/garland_rails/templates/uninstall_migration.rb
+- lib/generators/garland_rails/templates/v0_to_v1_migration.rb
+- lib/generators/garland_rails/uninstall_generator.rb
+- lib/generators/garland_rails/upgrade_generator.rb
 homepage: https://github.com/kengho/garland
 licenses:
 - MIT
@@ -56,5 +62,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: HashDiff ActiveRecord storage
+summary: HashDiff Rails storage
 test_files: []