planter 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b66f9b16f720b193d4dee6e0a23382b22a073982634bccbad2d52092516090eb
-  data.tar.gz: 5d66d7905379b7b148586b52b85afb2d715501543e88f0d84a88973b734d9f6b
+  metadata.gz: b2283785564306f87b6399b8af3e5343930b451e4bd64a10d8ac66acb0a7a7fa
+  data.tar.gz: ee9993b9e3d076dd5ecee3bbb61135904b0f1e8467bf11feadf043d89c47b42f
 SHA512:
-  metadata.gz: dde579bb6c055ce0c819148d1d818b39bf44ef9e75c692799dd760c7f9a96a0828d959f3204e6741fa55c41a6b9c2d8045f746142c139b5f20f1ea450ba7b259
-  data.tar.gz: 9f208c04796ae9f80ce6d46b4ec94e56da4fc2c62c36abf3198d806621bf2c7d79d9f52fd2d30ad0ee73c94206e7f0997b953ff93dbc93b83ff8064ee7ab85ed
+  metadata.gz: 8fda738209e6d82abff3d7bc8c3db1d29206924f63d95799d61265b228b09d48d2bded51e0997655225f509e2b70c4b2a3666e6d1ff766f4d7f321951ed7136d
+  data.tar.gz: 7e080b039a593a04e2f278a74aad865db841c8235d1921f47b2ba28da4be7ccf75ec7eb562d5ea7b5ab12b30ba46093ba7952503e39fd44b22d1298c511604da

data/README.md

@@ -58,8 +58,8 @@ Planter.configure do |config|
   # config.seeders_directory, which can be changed below. When a new
   # seeder is generated, it will be appended to the bottom of this
   # list. If the order is incorrect, you'll need to adjust it.
-  # Just be sure to keep the ending bracket on its own line, or the
-  # generator won't know where to put new elements.
+  # The generator can append to either multiline or inline %i[...]
+  # arrays.
   config.seeders = %i[
   ]
 
@@ -75,6 +75,11 @@ Planter.configure do |config|
   # When true, don't print output when seeding.
   config.quiet = false
 
+  ##
+  # When false, don't print progress bars while seeding.
+  # This is ignored when config.quiet is true.
+  config.progress_bar = true
+
   ##
   # The default trim mode for ERB. Valid modes are:
   # '%'  enables Ruby code processing for lines beginning with %
@@ -136,8 +141,8 @@ things to note.
 
 - The seeder will always be appended at the end of the array. If this is not the
 correct order, you'll need to adjust the array manually.
-- When adjusting the array, always keep the closing bracket on its own line, or
-the generator won't know where to put the new seeders.
+- The generator can append to either multiline or inline `%i[...]` seeders
+arrays.
 
 You can also tell the generator which seeding style to use.
 

data/lib/generators/planter/initializer_generator.rb

@@ -26,8 +26,8 @@ module Planter
             # config.seeders_directory, which can be changed below. When a new
             # seeder is generated, it will be appended to the bottom of this
             # list. If the order is incorrect, you'll need to adjust it.
-            # Just be sure to keep the ending bracket on its own line, or the
-            # generator won't know where to put new elements.
+            # The generator can append to either multiline or inline %i[...]
+            # arrays.
             config.seeders = %i[
             ]
 
@@ -43,6 +43,11 @@ module Planter
             # When true, don't print output when seeding.
             config.quiet = false
 
+            ##
+            # When false, don't print progress bars while seeding.
+            # This is ignored when config.quiet is true.
+            config.progress_bar = true
+
             ##
             # The default trim mode for ERB. Valid modes are:
             # '%'  enables Ruby code processing for lines beginning with %

data/lib/generators/planter/seeder_generator.rb

@@ -50,9 +50,7 @@ module Planter
 
         create_csv(seeder) if selected_seeding_method == :csv
 
-        inject_into_file "config/initializers/planter.rb",
-          "    #{seeder}\n",
-          before: /^\s*\]\s*$/
+        register_seeder(seeder)
       end
 
       def seeder_contents
@@ -94,6 +92,110 @@ module Planter
         end.join
       end
 
+      def register_seeder(seeder)
+        contents = ::File.read(initializer_full_path)
+        ::File.write(initializer_full_path, add_seeder_to_initializer(contents, seeder))
+      end
+
+      def add_seeder_to_initializer(contents, seeder)
+        assignment = contents.match(seeders_assignment_pattern)
+        unless assignment
+          raise Thor::Error, "Could not find config.seeders = %i[...] in #{initializer_path}"
+        end
+
+        opening_bracket_index = assignment.end(0) - 1
+        closing_bracket_index = closing_bracket_index_for(contents, opening_bracket_index)
+        unless closing_bracket_index
+          raise Thor::Error,
+            "Could not find the closing bracket for config.seeders in #{initializer_path}"
+        end
+
+        insert_seeder(contents, seeder, assignment[1], opening_bracket_index, closing_bracket_index)
+      end
+
+      def insert_seeder(
+        contents,
+        seeder,
+        assignment_indent,
+        opening_bracket_index,
+        closing_bracket_index
+      )
+        body = contents[(opening_bracket_index + 1)...closing_bracket_index]
+        updated = contents.dup
+
+        if body.include?("\n")
+          insert_multiline_seeder(
+            updated,
+            contents,
+            seeder,
+            assignment_indent,
+            body,
+            closing_bracket_index
+          )
+        elsif body.strip.empty?
+          updated.insert(closing_bracket_index, seeder)
+        else
+          updated.insert(closing_bracket_index, " #{seeder}")
+        end
+
+        updated
+      end
+
+      def insert_multiline_seeder(
+        updated,
+        contents,
+        seeder,
+        assignment_indent,
+        body,
+        closing_bracket_index
+      )
+        closing_line_start = contents.rindex("\n", closing_bracket_index) + 1
+        closing_line_prefix = contents[closing_line_start...closing_bracket_index]
+
+        if closing_line_prefix.match?(/\A[ \t]*\z/)
+          updated.insert(closing_line_start, "#{seeder_indent(body, assignment_indent)}#{seeder}\n")
+        else
+          updated.insert(closing_bracket_index, " #{seeder}")
+        end
+      end
+
+      def seeder_indent(body, assignment_indent)
+        item_line = body.lines.find { |line| line.match?(/\S/) }
+        indent = item_line&.match(/\A[ \t]*/).to_s
+        indent.empty? ? "#{assignment_indent}  " : indent
+      end
+
+      def closing_bracket_index_for(contents, opening_bracket_index)
+        depth = 1
+        index = opening_bracket_index + 1
+
+        while index < contents.length
+          if contents[index] == "\\"
+            index += 2
+            next
+          elsif contents[index] == "["
+            depth += 1
+          elsif contents[index] == "]"
+            depth -= 1
+            return index if depth.zero?
+          end
+
+          index += 1
+        end
+      end
+
+      def seeders_assignment_pattern
+        /^([ \t]*)config\.seeders\s*=\s*%i\[/
+      end
+
+      def initializer_path
+        "config/initializers/planter.rb"
+      end
+
+      def initializer_full_path
+        ::File.join(destination_root, initializer_path)
+      end
+
       def selected_seeding_method
         return unless options["seeding_method"]
 

data/lib/planter/config.rb

@@ -42,6 +42,14 @@ module Planter
     # @return [Boolean]
     attr_accessor :quiet
 
+    ##
+    # When false, don't print progress bars while seeding.
+    #
+    # @param [Boolean] progress_bar
+    #
+    # @return [Boolean]
+    attr_accessor :progress_bar
+
     ##
     # The default trim mode for ERB. Must be "%", "<>", ">", or "-".
     # For more information, see documentation for +ERB::new+.
@@ -72,6 +80,7 @@ module Planter
     # Create a new instance of the config.
     def initialize
       @quiet = false
+      @progress_bar = true
       @seeders_directory = ::File.join("db", "seeds")
       @csv_files_directory = ::File.join("db", "seed_files")
     end

data/lib/planter/progress_bar.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "ruby-progressbar"
+
+module Planter
+  ##
+  # Builds progress bars for seed runs.
+  class ProgressBar
+    FORMAT = "%t |%B| %p%% %c/%C"
+
+    class NullProgressBar
+      def increment
+      end
+    end
+
+    def self.create(title:, total:, output: $stdout)
+      return NullProgressBar.new unless enabled?(total)
+
+      ::ProgressBar.create(
+        title: title,
+        total: total,
+        output: output,
+        format: FORMAT
+      )
+    end
+
+    def self.enabled?(total)
+      total.positive? && Planter.config.progress_bar && !Planter.config.quiet
+    end
+    private_class_method :enabled?
+  end
+end

data/lib/planter/seeder.rb

@@ -261,17 +261,35 @@ module Planter
     ##
     # Creates records from the +data+ attribute.
     def create_records
-      context.number_of_records.times do
-        data.each { |record| create_record(record) }
+      records = data
+      progress_bar = progress_bar(total: context.number_of_records * records.size)
+
+      context.number_of_records.times do |index|
+        records = data if index.positive?
+        records.each do |record|
+          create_record(record)
+          progress_bar.increment
+        end
       end
     end
 
     ##
     # Create records from the +data+ attribute for each record in the +parent+.
     def create_records_from_parent
-      adapter.parent_ids(context: context).each do |parent_id|
-        context.number_of_records.times do
-          data.each { |record| create_record(record, parent_id: parent_id) }
+      parent_ids = adapter.parent_ids(context: context)
+      return if parent_ids.empty?
+
+      records = data
+      total = parent_ids.size * context.number_of_records * records.size
+      progress_bar = progress_bar(total: total)
+
+      parent_ids.each_with_index do |parent_id, parent_index|
+        context.number_of_records.times do |number_index|
+          records = data if parent_index.positive? || number_index.positive?
+          records.each do |record|
+            create_record(record, parent_id: parent_id)
+            progress_bar.increment
+          end
         end
       end
     end
@@ -327,5 +345,9 @@ module Planter
     def adapter
       Planter.config.adapter
     end
+
+    def progress_bar(total:)
+      Planter::ProgressBar.create(title: context.table_name, total: total)
+    end
   end
 end

data/lib/planter/version.rb

@@ -21,7 +21,7 @@ module Planter
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 0
+    PATCH = 2
 
     module_function
 

data/lib/planter.rb

@@ -7,6 +7,7 @@ require "planter/railtie"
 require "planter/config"
 require "planter/seed_context"
 require "planter/csv_data_source"
+require "planter/progress_bar"
 require "planter/record_attributes"
 require "planter/seeder"
 require "planter/validator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Evan Gray
@@ -43,6 +43,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ files:
 - lib/planter/adapters/active_record.rb
 - lib/planter/config.rb
 - lib/planter/csv_data_source.rb
+- lib/planter/progress_bar.rb
 - lib/planter/railtie.rb
 - lib/planter/record_attributes.rb
 - lib/planter/seed_context.rb