smart_seeds 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b99224e6c643baa7701ee678670bbf115b730795
-  data.tar.gz: f14a1e71eceb7e8b794ac5e02d5cb59e7395774d
+  metadata.gz: 4aca1c67df762de136d3c7bd6435220424253522
+  data.tar.gz: f3b0810b6ae0c9d7af2e6b2a1ce17d71ac9c2a6a
 SHA512:
-  metadata.gz: d37fec684349ca72a2bff8e651fc27c91b463dd123afff2bfcea8783dd425d6e9a1838cfd59bfb9aaf202e47e8535464bc1e4a1281aa75af4861d8e3c6c4639c
-  data.tar.gz: c7bec0972215ef472ad6e40231fe1c2f6a44f9eb6736c5afe7bfcea3e97092ed1c75ce1361f7f531ac2b92dd141f911fa1f03b1c950c9cd3dea4286430f3cca4
+  metadata.gz: 2c0356fcb1055780b580c6480f008449d2f673b2e21d1ec35850970d03e62ba9a66a57765912500537d9d434e8df0e163ab55fb1f1bcfe91a2aaadc1bdf6d824
+  data.tar.gz: b7f912df9d79e5136e0dd98b6d2e00ff45fc30c16e95daadf65f4754407220463f97a8af8943ed96cb6e012e3b879f213552d5b0cb94af53dcf468d3e6be3567

data/README.md

@@ -1,8 +1,53 @@
 # SmartSeeds
-Short description and motivation.
+Gem for an auto-smart generating the seeds in your Rails app. 
+It defines types columns in a model and generates random values for each of these fields.
 
 ## Usage
-How to use my plugin.
+
+For example `Entity` model has `name`, `age`, `is_human` attributes.
+
+All you need to do is run this command: `SmartSeeds.plant(Entity)`
+```
+> SmartSeeds.plant(Entity)
+   (0.1ms)  begin transaction
+  SQL (0.4ms)  INSERT INTO "entities" ("id", "name", "age", "is_human", "created_at", "updated_at") VALUES (?, ?, ?, ?, ?, ?)  [["id", 369], ["name", "Heil"], ["age", 344], ["is_human", false], ["created_at", 2017-01-15 16:10:50 UTC], ["updated_at", 2017-01-15 16:10:50 UTC]]
+   (1.8ms)  commit transaction
+ => true 
+
+```
+And we've got an object in a database:
+```
+> Entity.last
+  Entity Load (0.2ms)  SELECT  "entities".* FROM "entities" ORDER BY "entities"."id" DESC LIMIT ?  [["LIMIT", 1]]
+ => #<Entity id: 1, name: "Heil", age: 344, is_human: false, created_at: "2017-01-15 16:10:50", updated_at: "2017-01-15 16:10:50"> 
+
+```
+### Custom values
+If you want to override some default values, you can send it in a hash:
+
+```
+> SmartSeeds.plant(Entity, {name: 'Aleah'})
+   (0.1ms)  begin transaction
+  SQL (0.4ms)  INSERT INTO "entities" ("id", "name", "age", "is_human", "created_at", "updated_at") VALUES (?, ?, ?, ?, ?, ?)  [["id", 167], ["name", "Aleah"], ["age", 374], ["is_human", false], ["created_at", 2017-01-15 16:15:15 UTC], ["updated_at", 2017-01-15 16:15:15 UTC]]
+   (1.6ms)  commit transaction
+ => true 
+```
+
+### Faker
+The gem has a simple integration with [Faker](https://github.com/stympy/faker).
+
+That means if you have a AR model which called like a some Faker class and an attribute called like a some faker method in that class 
+a value will be generated by Faker gem. 
+
+For example: Model `Superhero` has the `name` and `power` attributes, so the value will be generated by `Faker::Superhero.name` and `Faker::Superhero.power`. [Superhero doc](https://github.com/stympy/faker/blob/master/doc/superhero.md).
+```
+> SmartSeeds.plant(Superhero)
+   (0.7ms)  begin transaction
+  SQL (2.8ms)  INSERT INTO "superheros" ("name", "power", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["name", "Cheetah Skull"], ["power", "Magic"], ["created_at", 2017-01-22 23:33:20 UTC], ["updated_at", 2017-01-22 23:33:20 UTC]]
+   (0.9ms)  commit transaction
+ => #<Superhero id: 8, name: "Ultra Firebird", power: "Magic", created_at: "2017-01-22 23:33:20", updated_at: "2017-01-22 23:33:20"> 
+
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/smart_seeds.rb

@@ -1,9 +1,22 @@
-require_relative 'generating'
-require_relative 'performing'
+require 'smart_seeds/performing'
+require 'smart_seeds/generator/base'
+require 'smart_seeds/generator/binary'
+require 'smart_seeds/generator/boolean'
+require 'smart_seeds/generator/date'
+require 'smart_seeds/generator/datetime'
+require 'smart_seeds/generator/decimal'
+require 'smart_seeds/generator/float'
+require 'smart_seeds/generator/integer'
+require 'smart_seeds/generator/string'
+require 'smart_seeds/generator/text'
+require 'smart_seeds/generator/time'
+require 'smart_seeds/generator/integer/enum'
+require 'smart_seeds/generator/integer/foreign_key'
+require 'smart_seeds/generator/faker'
 
 module SmartSeeds
-  def self.call(model, attrs={})
-    perform = Performing.new(model, attrs)
+  def self.plant(model, attrs={})
+    perform = SmartSeeds::Performing.new(model, attrs)
     perform.call
   end
 end

data/lib/smart_seeds/generator/base.rb

@@ -0,0 +1,39 @@
+# Available types of AR model are: :binary, :boolean, :date, :datetime, :decimal, :float, :integer, :string, :text, :time
+# There are generators for all of these types, for example SmartSeeds::Generator::Integer
+
+module SmartSeeds
+  module Generator
+    class Base
+      def initialize(column, model)
+        @column = column
+        @model = model
+      end
+
+      # Get class name of specific generator and execute generate value method
+      def generate_value
+        if is_comatible_with_faker?
+          generate_via_faker
+        else
+          begin
+            klass = "SmartSeeds::Generator::#{column.type.to_s.capitalize}".constantize
+            klass.new(column, model).generate_value
+          rescue Exception => e
+            puts e.inspect
+          end
+        end
+      end
+
+      protected
+
+      attr_reader :column, :model
+
+      def is_comatible_with_faker?
+        SmartSeeds::Generator::Faker.new(column, model).is_compatible?
+      end
+
+      def generate_via_faker
+        SmartSeeds::Generator::Faker.new(column, model).generate_value
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/binary.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Binary < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        '0b100'
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/boolean.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Boolean < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        [true, false].sample
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/date.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Date < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        DateTime.now.to_date
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/datetime.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Datetime < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        DateTime.now
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/decimal.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Decimal < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        rand(6.6...6666.0).round(2)
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/faker.rb

@@ -0,0 +1,41 @@
+module SmartSeeds
+  module Generator
+    class Faker < SmartSeeds::Generator::Base
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        faker_class.send(column.name.to_sym)
+      end
+
+      def is_compatible?
+        true if faker_classes_include_model_name? && faker_methods_include_column_name?
+      end
+
+      private
+
+      def faker_classes_include_model_name?
+        # Check if Faker has a Class which called as a AR Model
+        faker_classes = ::Faker.constants.select {|c| ::Faker.const_get(c).is_a? Class}
+        faker_classes.include? model.name.to_sym
+      end
+
+      def faker_methods_include_column_name?
+        # Support methods are included in Faker generate class
+        support_singleton_methods = %i(method_missing fetch translate parse with_locale unique numerify letterify bothify regexify fetch_all flexible rand_in_range yaml_tag)
+
+        klass = faker_class
+
+        # Here is should stay only methods for generating random values without support methods like:
+        # => [:name, :prefix, :suffix, :power, :descriptor]
+        faker_methods = klass.singleton_methods - support_singleton_methods
+        faker_methods.include? column.name.to_sym
+      end
+
+      def faker_class
+        "Faker::#{model.name.capitalize}".constantize
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/float.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Float < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        rand(6.6...6666.0).round(2)
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/integer.rb

@@ -0,0 +1,37 @@
+module SmartSeeds
+  module Generator
+    class Integer < SmartSeeds::Generator::Base
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        if is_an_enum?
+          generate_enum
+        elsif is_foreign_key?
+          generate_foreign_key
+        else
+          rand(1..66666)
+        end
+      end
+
+      private
+
+      def is_an_enum?
+        SmartSeeds::Generator::Enum.new(column, model).is_an_enum?
+      end
+
+      def generate_enum
+        SmartSeeds::Generator::Enum.new(column, model).generate_value
+      end
+
+      def is_foreign_key?
+        SmartSeeds::Generator::ForeignKey.new(column, model).is_a_foreign_key?
+      end
+
+      def generate_foreign_key
+        SmartSeeds::Generator::ForeignKey.new(column, model).generate_value
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/integer/enum.rb

@@ -0,0 +1,21 @@
+module SmartSeeds
+  module Generator
+    class Enum < SmartSeeds::Generator::Integer
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        # Extract all values from enum hash
+        # {"status"=>{"active"=>0, "in_progress"=>1, "archived"=>2}}
+        # Get [0, 1, 2]
+        values_array = model.defined_enums[column.name].values
+        values_array.sample
+      end
+
+      def is_an_enum?
+        model.defined_enums.include?(column.name)
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/integer/foreign_key.rb

@@ -0,0 +1,18 @@
+module SmartSeeds
+  module Generator
+    class ForeignKey < SmartSeeds::Generator::Integer
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        klass = column.name.split('_').first.capitalize.constantize
+        klass.ids.sample
+      end
+
+      def is_a_foreign_key?
+        true if column.name.split('_').last == 'id'
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/string.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class String < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        ::Faker::Lorem.word
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/text.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Text < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        ::Faker::Lorem.paragraph
+      end
+    end
+  end
+end

data/lib/smart_seeds/generator/time.rb

@@ -0,0 +1,14 @@
+module SmartSeeds
+  module Generator
+    class Time < SmartSeeds::Generator::Base
+
+      def initialize(column, model)
+        super
+      end
+
+      def generate_value
+        DateTime.now.to_time
+      end
+    end
+  end
+end

data/lib/smart_seeds/performing.rb

@@ -0,0 +1,51 @@
+module SmartSeeds
+  class Performing
+    SKIPPABLE_COLUMN_NAMES = %w(id created_at updated_at)
+
+    def initialize(model, attrs)
+      @attrs = attrs
+      @model = model
+      @object = model.new
+    end
+
+    def call
+      set_default_values
+
+      # User can send custom values in a hash: SmartSeeds.(Entity, {name: 'Aleah'})
+      # This method overrides default values to custom('name' in the example above)
+      set_custom_values if attrs.any?
+
+      object.save!
+      object
+    end
+
+    private
+
+    attr_reader :attrs
+    attr_reader :model
+    attr_reader :object
+
+    def set_default_values
+      model.columns.each do |column|
+        next if is_column_must_be_skipped?(column.name)
+        object[column.name] = generate_value(column)
+      end
+    end
+
+    def set_custom_values
+      attrs.each do |attr|
+        key = attr.first
+        value = attr.last
+        object[key.to_s] = value
+      end
+    end
+
+    def generate_value(column)
+      SmartSeeds::Generator::Base.new(column, model).generate_value
+    end
+
+    def is_column_must_be_skipped?(column_name)
+      SmartSeeds::Performing::SKIPPABLE_COLUMN_NAMES.include?(column_name)
+    end
+  end
+end

data/lib/smart_seeds/version.rb

@@ -1,3 +1,3 @@
 module SmartSeeds
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_seeds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Vitaliy Fry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: Description of Autoseed.
 email:
 - vitaliy.fry@gmail.com
@@ -48,11 +62,23 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/generating.rb
-- lib/performing.rb
 - lib/smart_seeds.rb
+- lib/smart_seeds/generator/base.rb
+- lib/smart_seeds/generator/binary.rb
+- lib/smart_seeds/generator/boolean.rb
+- lib/smart_seeds/generator/date.rb
+- lib/smart_seeds/generator/datetime.rb
+- lib/smart_seeds/generator/decimal.rb
+- lib/smart_seeds/generator/faker.rb
+- lib/smart_seeds/generator/float.rb
+- lib/smart_seeds/generator/integer.rb
+- lib/smart_seeds/generator/integer/enum.rb
+- lib/smart_seeds/generator/integer/foreign_key.rb
+- lib/smart_seeds/generator/string.rb
+- lib/smart_seeds/generator/text.rb
+- lib/smart_seeds/generator/time.rb
+- lib/smart_seeds/performing.rb
 - lib/smart_seeds/version.rb
-- lib/tasks/autoseed_tasks.rake
 homepage: http://frylock.me
 licenses:
 - MIT

data/lib/generating.rb

@@ -1,41 +0,0 @@
-module Generating
-  AVAILABLE_TYPES = %i(
-                       binary
-                       boolean
-                       date
-                       datetime
-                       decimal
-                       float
-                       integer
-                       string
-                       text
-                       time
-                      )
-
-  def self.generate_value(column_type)
-    raise ArgumentError, "There is no column type #{column_type}" unless Generating::AVAILABLE_TYPES.include?(column_type)
-
-    case column_type
-    when :binary
-      '0b100'
-    when :boolean
-      [true, false].sample
-    when :date
-      DateTime.now.to_date
-    when :datetime
-      DateTime.now
-    when :decimal
-      rand(6.6...666.0).round(2)
-    when :float
-      rand(6.6...666.0).round(2)
-    when :integer
-      rand(1...666)
-    when :string
-      'Heil'
-    when :text
-      'BIG text'
-    when :time
-      DateTime.now.to_time
-    end
-  end
-end

data/lib/performing.rb

@@ -1,41 +0,0 @@
-class Performing
-  def initialize(model, attrs)
-    @attrs = attrs
-    @model = model
-    @object = model.new
-  end
-
-  def call
-    set_default_values
-    set_custom_values if attrs.any?
-
-    object.save!
-  end
-
-  private
-
-  attr_reader :attrs
-  attr_reader :model
-  attr_reader :object
-
-  def set_default_values
-    model.columns.each do |column|
-      column_name = column.name
-      column_type = column.type
-
-      object[column_name] = generate_value(column_type)
-    end
-  end
-
-  def set_custom_values
-    attrs.each do |attr|
-      key = attr.first
-      value = attr.last
-      object[key.to_s] = value
-    end
-  end
-
-  def generate_value(column_type)
-    Generating.generate_value(column_type)
-  end
-end

data/lib/tasks/autoseed_tasks.rake

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