seed_gimmick 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aceba72060bab98a41a0d8427ed09c9a1bf83338
-  data.tar.gz: 85ff18ec13553c2c3fd5fc6c36c3b3cafe0a6f66
+  metadata.gz: 9b3f2287df970cf60ef0a9c7db0cd8a11c6c14f0
+  data.tar.gz: 9d71742e3197bc0cb2e08705044760adf02863d4
 SHA512:
-  metadata.gz: 48768e2ace6be4b85f2558ef2726e7ef867b9f956f4bfd78cacc665be3376ef1ac517f08cf01ee19768daf71def30a73fc9c6205a79f7c5658893e33662f5a2f
-  data.tar.gz: 84d28b1cb0489fc9dd8aa2fea8ce52ba7141bca70be3cca103f38983263d1a9d454b6c46e5ad7a8c2f40b86d2163ac8d18b04781c0ac09cddab3b4d95b77c730
+  metadata.gz: 265d168da24914c99ed796489e780a5e5e2d3d096ac1c85928afe2eb52af4c1775a2351cf29b0ecfdde00f67f63e70a3be52332680b83c6f505b5fa3823ff209
+  data.tar.gz: 3abee3493f1e12cdbf8b5b4f3bbfad2fde5158863558d2a5880355be41bb7f2379f4dd3856fac49238208a01a3ed1f3a5515d4cd2b5b19047c0679ea22edbe4a

data/README.md

@@ -43,7 +43,15 @@ $ [TABLES=table_name,table_name] bundle exec rake db:seed_gimmick
 Dump to fixture file from database in seed directory.
 
 ```
-$ MODELS=ModelName,ModelName bundle exec rake db:seed_gimmick:dump
+$ MODELS=ModelName,ModelName [FORMAT=csv] bundle exec rake db:seed_gimmick:dump
+```
+
+#### Diff
+
+Display the database and seed difference.
+
+```
+$ bundle exec rake seed_gimmick:diff
 ```
 
 ## Contributing

data/lib/seed_gimmick.rb

@@ -26,6 +26,16 @@ module SeedGimmick
         Seed.new(model_name, options).dump
       end
     end
+
+    def diff(options = nil)
+      SeedGimmick::Seed.find(options).each do |seed|
+        ActiveRecord::Migration.say_with_time(seed.table_name) do
+          seed.compare.each do |changed|
+            puts [changed.flag, changed.id, changed.change_values].join("\t")
+          end
+        end
+      end
+    end
   end
 end
 

data/lib/seed_gimmick/inflector.rb

@@ -7,10 +7,15 @@ module SeedGimmick
         new(options || Options.new)
       end
 
+      # Convert String to model class.
+      # @param name [String]
       def model_class(name)
         name.try(:safe_constantize)
       end
 
+      # Convert String to Pathname.
+      # @return [Pathname]
+      # @return [nil]
       def pathname(path)
         case path
         when Pathname then path
@@ -18,27 +23,44 @@ module SeedGimmick
         else nil
         end
       end
+
+      # Path without extension.
+      # @return [Pathname]
+      def without_ext(path)
+        pathname(path).dirname.join(pathname(path).basename(".*"))
+      end
+
+      # Extension type.
+      # @return [Symbol]
+      def ext_type(path)
+        pathname(path).extname.sub(/\A./, '').to_sym
+      end
     end
 
     def initialize(options)
-      @seed_dir = options.seed_dir
+      @seed_dir = pathname(options.seed_dir)
     end
 
+    # Convert seed file path to model class.
+    # @param seed_file [Pathname]
+    # @return [ActiveRecord::Base]
     def model_for(seed_file)
-      class_name = relative_path(without_ext(seed_file)).to_s.classify
-      self.class.model_class(class_name)
+      name = from_seed_dir(self.class.without_ext(seed_file)).to_s.classify
+      self.class.model_class(name)
     end
 
+    # Convert model class to seed file path.
+    # @param model [ActiveRecord::Base]
+    # @param format [Symbol] Extension type.
+    # @return [Pathname]
     def seed_for(model, format = :yml)
-      seed_dir + pathname(model.model_name.collection).sub_ext(".#{format}")
+      seed_dir.join(pathname(model.model_name.collection).sub_ext(".#{format}"))
     end
 
     private
-      def without_ext(path)
-        path.dirname + path.basename(".*")
-      end
-
-      def relative_path(path)
+      # Convert lerative path from seed_dir.
+      def from_seed_dir(path)
+        path = pathname(path)
         path.relative? ? path : path.relative_path_from(seed_dir)
       end
 

data/lib/seed_gimmick/options.rb

@@ -1,11 +1,11 @@
 module SeedGimmick
   class Options
     VALID_OPTIONS_KEYS = %i(
-    seed_dir
-    tables
-    models
-    default_ext
-    exclude_columns
+      seed_dir
+      tables
+      models
+      default_ext
+      exclude_columns
     ).freeze
 
     VALID_OPTIONS_KEYS.each do |key|

data/lib/seed_gimmick/seed.rb

@@ -1,3 +1,5 @@
+require "seed_gimmick/seed/difference"
+
 module SeedGimmick
   class Seed
     class << self
@@ -35,6 +37,10 @@ module SeedGimmick
       @seed_file ||= @inflector.seed_for(@model, (ext || @options.default_ext))
     end
 
+    def seed_io
+      @seed_io ||= SeedIO.factory(seed_file)
+    end
+
     def table_name
       model.model_name.plural
     end
@@ -45,27 +51,28 @@ module SeedGimmick
       model.column_names - exclude_columns
     end
 
-    def load_file
-      SeedIO.get(seed_file).load_data
-    end
-
-    def write_file(array_of_hashes)
-      SeedIO.get(seed_file).dump_data(array_of_hashes)
-    end
-
     def bootstrap
       ActiveRecord::Migration.say_with_time(table_name) do
         model.transaction do
           model.delete_all
-          model.import(load_file.map {|hash| model.new(hash) })
+          model.import(seed_io.values.map {|hash| model.new(hash) })
         end
+        seed_io.values.size
       end
     rescue LoadFailed => e
       $stdout.print e.message
     end
 
     def dump(exclude_columns = [])
-      write_file(model.select(*dump_columns(exclude_columns)).map(&:attributes))
+      ActiveRecord::Migration.say_with_time(table_name) do
+        seed_io.dump_data(
+          model.select(*dump_columns(exclude_columns)).map(&:attributes)
+        )
+      end
+    end
+
+    def compare
+      Difference.extraction(self)
     end
 
     private

data/lib/seed_gimmick/seed/difference.rb

@@ -0,0 +1,81 @@
+module SeedGimmick
+  class Seed
+    class Difference
+      include Enumerable
+
+      attr_reader :changes
+
+      module Flag
+        DATABASE = "-"
+        SEED = "+"
+        CHANGE = "<>"
+      end
+
+      class << self
+        def extraction(seed)
+          pk = seed.model.primary_key
+          database = seed.model.all.each_with_object({}) {|row, obj|
+            obj[row.public_send(pk)] = row
+          }
+          seed_data = seed.seed_io.values.each_with_object({}) {|row, obj|
+            obj[row[pk].to_i] = row
+          }
+          diff = []
+          (database.keys - seed_data.keys).each do |id|
+            diff << [Flag::DATABASE, id, database.delete(id), nil, nil]
+          end
+          (seed_data.keys - database.keys).each do |id|
+            diff << [Flag::SEED, id, nil, seed_data.delete(id), nil]
+          end
+          database.each do |id, row|
+            s_attrs = seed_data[id].dup
+            s_attrs.delete(pk)
+            row.assign_attributes(s_attrs)
+            if row.changed?
+              changes = row.changes
+              changes.each {|k,(old,_)| row.public_send("#{k}=", old) }
+              diff << [Flag::CHANGE, id, row, seed_data.delete(id), changes]
+            end
+          end
+          new(diff)
+        end
+      end
+
+      def initialize(diff)
+        @changes = diff.sort_by(&:second).map {|d| Change.new(*d) }
+      end
+
+      def changed?
+        !@changes.empty?
+      end
+
+      def each
+        @changes.each do |change|
+          yield change
+        end
+      end
+
+      class Change < Struct.new(:flag, :id, :database, :seed_data, :changes)
+        EXCLUDES = [
+          "created_at",
+          "updated_at"
+        ].freeze
+
+        def change_values
+          changes.presence || changes_from_data
+        end
+
+        private
+          def changes_from_data
+            if database
+              attrs = database.attributes
+              attrs.reject! {|k,_| EXCLUDES.include?(k) } || attrs
+            else
+              seed_data
+            end
+          end
+      end
+    end
+  end
+end
+

data/lib/seed_gimmick/seed_io.rb

@@ -1,18 +1,42 @@
 require "seed_gimmick/seed_io/base"
 require "seed_gimmick/seed_io/yaml_file"
+require "seed_gimmick/seed_io/csv_file"
 
 module SeedGimmick
   module SeedIO
+    module ExtType
+      # Collection map
+      # @note Require Symbol keys and String values.
+      CORRECTION = {
+        yml: "yaml",
+      }.freeze
+
+      # Corrected the fluctuation of extension.
+      # @param seed_file [String]
+      # @param seed_file [Pathname]
+      # @return [String]
+      def self.decision(path)
+        ext = Inflector.ext_type(path)
+        CORRECTION[ext].presence || ext.to_s
+      end
+    end
+
     class << self
-      def get(seed_file)
+      # Generate of IO class from seed_file path.
+      # @param seed_file [String]
+      # @param seed_file [Pathname]
+      # @return [SeedIO] Target IO class.
+      def factory(seed_file)
+        seed_file = Inflector.pathname(seed_file) || (raise ArgumentError)
         const_get(io_class_name_for(seed_file), false).new(seed_file)
       end
 
       private
+        # Convert seed_file path to IO class name.
+        # @param seed_file [Pathname]
+        # @return [String] Target IO class name.
         def io_class_name_for(seed_file)
-          ext = Inflector.pathname(seed_file).extname.sub(/\A\./, "")
-          ext = "yaml" if ext == "yml"
-          "%sFile" % ext.capitalize
+          "%sFile" % ExtType.decision(seed_file).capitalize
         end
     end
   end

data/lib/seed_gimmick/seed_io/base.rb

@@ -1,21 +1,52 @@
 module SeedGimmick
   module SeedIO
     class Base
-      attr_reader :seed_file
+      BASE_DATA_KEYS = %i(values metadata).freeze
 
+      attr_reader *[:seed_file].concat(BASE_DATA_KEYS)
+
+      # Data access callbacks.
+      BASE_DATA_KEYS.each do |key|
+        define_method "#{key}_with_load_if_not_data" do
+          public_send("#{key}_without_load_if_not_data") || load_data[key]
+        end
+        alias_method_chain key, :load_if_not_data
+      end
+
+      # @param seed_file [Pathname]
       def initialize(seed_file)
         @seed_file = seed_file
       end
 
+      # Data load from seed file.
+      # @note Need to return self or load data with Hash.
       def load_data
         raise NotImplementedError
       end
 
+      # Data dump to seed file.
+      # @param array_of_hashes [Array<Hash>]
+      # @return [Integer] number of dump data.
       def dump_data(array_of_hashes)
         raise NotImplementedError
       end
 
+      # Data access with bracket.
+      def [](key)
+        raise ArgumentError unless BASE_DATA_KEYS.include?(key)
+        public_send(key.to_sym)
+      end
+
       private
+        # Update accessible data from Array of Hashes.
+        # @param array_of_hashes [Array<Hash>] loaded data.
+        def set_data(array_of_hashes)
+          @values = array_of_hashes
+          @metadata = {
+            rows: @values.size,
+          }
+        end
+
         def write_raw(data)
           seed_file.dirname.mkpath
           seed_file.open("w") {|f| f.write data }

data/lib/seed_gimmick/seed_io/csv_file.rb

@@ -0,0 +1,23 @@
+module SeedGimmick
+  module SeedIO
+    class CsvFile < Base
+      def self.raw_data(array_of_hashes)
+        columns = array_of_hashes.first.keys
+        array_of_hashes.map(&:values).unshift(columns).map(&:to_csv).join
+      end
+
+      def load_data
+        data = CSV.read(seed_file, headers: :first_row).map(&:to_hash) ||
+          (raise LoadFailed.new(seed_file))
+        set_data(data)
+        self
+      end
+
+      def dump_data(array_of_hashes)
+        write_raw(self.class.raw_data(array_of_hashes))
+        array_of_hashes.size
+      end
+    end
+  end
+end
+

data/lib/seed_gimmick/seed_io/yaml_file.rb

@@ -1,24 +1,30 @@
 module SeedGimmick
   module SeedIO
     class YamlFile < Base
+      class << self
+        def raw_data(array_of_hashes)
+          data = {}
+          array_of_hashes.each.with_index(1) do |row, i|
+            data[data_key(i)] = row
+          end
+          data.to_yaml
+        end
+
+        def data_key(id)
+          "data%d" % id
+        end
+      end
+
       def load_data
         data = YAML.load_file(seed_file) || (raise LoadFailed.new(seed_file))
-        data.values
+        set_data(data.values)
+        self
       end
 
       def dump_data(array_of_hashes)
-        data = {}
-        array_of_hashes.each.with_index(1) do |row, i|
-          data[data_key(i)] = row
-        end
-
-        write_raw(data.to_yaml)
+        write_raw(self.class.raw_data(array_of_hashes))
+        array_of_hashes.size
       end
-
-      private
-        def data_key(id)
-          "data%d" % id
-        end
     end
   end
 end

data/lib/seed_gimmick/version.rb

@@ -1,3 +1,3 @@
 module SeedGimmick
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/tasks/seed_gimmick.rake

@@ -20,4 +20,9 @@ namespace :seed_gimmick do
   task :seed_files do
     pp SeedGimmick::Seed.find.map {|seed| seed.seed_file.to_s }
   end
+
+  task :diff => :environment do
+    SeedGimmick.diff
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seed_gimmick
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-24 00:00:00.000000000 Z
+date: 2015-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,8 +100,10 @@ files:
 - lib/seed_gimmick/options.rb
 - lib/seed_gimmick/railtie.rb
 - lib/seed_gimmick/seed.rb
+- lib/seed_gimmick/seed/difference.rb
 - lib/seed_gimmick/seed_io.rb
 - lib/seed_gimmick/seed_io/base.rb
+- lib/seed_gimmick/seed_io/csv_file.rb
 - lib/seed_gimmick/seed_io/yaml_file.rb
 - lib/seed_gimmick/version.rb
 - lib/tasks/seed_gimmick.rake