k_seeder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6a7ddaedb934076310cf4b99b27d2ea3ccd4710c8a0a55e49b600a272739ca1
+  data.tar.gz: c98920ddb180912a37ded27e3fa5e6f041b359217197d9bf0d5ffc291f7aaf93
+SHA512:
+  metadata.gz: 370bf2752b8eee2e679879e6931de42eecd9c7403ed0e8fd7403d1c2e64e9e75aea8a6b47fe295d7c68c50ef0179b35b191f30c34c6c18c79b46c48ef329a10b
+  data.tar.gz: bc7e1d193b97114b0ecafe5c47b5899ef9a9c97fc229027eb3f389ac75e95ab87e87275889c3862c4e4f78129733254a8df63e98ae3b7f863868249425fcdc20

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ricardo.ds.marques@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in k_seeder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    k_seeder (0.1.0)
+      faker (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    faker (1.8.7)
+      i18n (>= 0.7)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  k_seeder!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ricardo Marques
+
+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,55 @@
+# KSeeder
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/k_seeder`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k_seeder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install k_seeder
+
+## Usage
+
+Just run the following command to seed your database
+
+```ruby
+rails seeder:seed
+```
+
+This will iterate through your `models` classes and will create 10 objects with [random data](https://github.com/stympy/faker)
+
+You can specify the number of records you want to create or the specific models you want to seed with the `ENTRIES` and `MODELS` arguments. Example:
+
+```ruby
+rails seeder:seed MODELS=user,company,project ENTRIES=30
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/k_seeder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the KSeeder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/k_seeder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "k_seeder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/k_seeder.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "k_seeder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "k_seeder"
+  spec.version       = KSeeder::VERSION
+  spec.authors       = ["Ricardo Marques"]
+  spec.email         = ["ricardo.ds.marques@gmail.com"]
+
+  spec.summary       = %q{Generic seeder for ActiveRecord rails instances.}
+  spec.description   = %q{Generic seeder for ActiveRecord rails instances.}
+  spec.homepage      = "https://github.com/kollegorna/k_seeder"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faker", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/k_seeder.rb

@@ -0,0 +1,27 @@
+require "faker"
+require "k_seeder/version"
+require "k_seeder/content"
+
+# rake tasks
+require "tasks/seeder"
+
+module KSeeder
+  def self.seed(class_name, entries)
+    # only accepting base level classes
+    return false if class_name.include?('::')
+
+    model_class = class_name.constantize
+    puts "Creating #{entries} #{model_class.to_s} instances..."
+
+    # seeding x instances of the model
+    (1..entries).each do |index|
+      model = model_class.new
+      model_class.columns.each do |field|
+        # filling each column by according to the column name/type
+        content = KSeeder::Content.new(model_class, field).fill
+        model[field.name] = content
+      end
+      model.save
+    end
+  end
+end

data/lib/k_seeder/content.rb

@@ -0,0 +1,112 @@
+class KSeeder::Content
+
+  def initialize(model, field)
+    @model = model
+    @field = field
+  end
+
+  def fill
+    return nil if ['id', 'created_at', 'updated_at'].include?(@field.name)
+
+    return fill_from_validations if has_validations?
+
+    # first checking if it's a fk
+    return fill_from_fk if is_fk? # TODO
+
+    # after checking if it's an enum
+    return fill_from_enum if is_enum?
+
+    # trying to fill field based on its name
+    content = fill_from_name
+    return content unless content.nil?
+
+    # finally filling content based on its type
+    fill_from_type
+  end
+
+  def fill_from_validations
+    return nil unless has_validations?
+    validation = @model.validators_on(@field.name).find { |v| !v.options[:in].nil? }
+
+    # returning a sample from the validation options
+    validation.options[:in].sample
+  end
+
+  def fill_from_enum
+    return nil unless is_enum?
+    @model.defined_enums[@field.name].values.sample
+  end
+
+  def fill_from_fk
+    return nil unless is_fk?
+
+    fk = @model.reflect_on_all_associations.find { |c| c.foreign_key == @field.name }
+    fk_class = fk.name.to_s.classify.constantize
+    fk_class.pluck(:id).sample
+  rescue NameError
+    # unexistant fk class
+    nil
+  end
+
+  def fill_from_name
+    case @field.name
+    when 'name'
+      # first checking for class name
+      case @model.to_s
+      when 'User'
+        Faker::Name.name
+      when 'City'
+        Faker::Address.city
+      when 'Company'
+        Faker::Company.name
+      when 'District'
+      when 'State'
+        Faker::Address.state
+      else # defaulting to regular name
+        Faker::Name.name
+      end
+    when 'email'
+      Faker::Internet.email
+    when 'first_name'
+      Faker::Name.first_name
+    when 'last_name'
+      Faker::Name.last_name
+    when 'phone_number'
+      Faker::PhoneNumber.cell_phone
+    end
+  end
+
+  def fill_from_type
+    case @field.type
+    when :string
+      Faker::Lorem.characters(@field.limit || 10)
+    when :integer
+      Faker::Number.between(1, 100)
+    when :float
+      Faker::Number.decimal(2)
+    when :boolean
+      Faker::Boolean.boolean
+    when :date
+    when :datetime
+      Faker::Date.backward(365)
+    when :text
+      Faker::Lorem.sentence
+    when :jsonb
+    end
+  end
+
+  private
+
+  def is_enum?
+    @model.defined_enums.has_key?(@field.name)
+  end
+
+  def is_fk?
+    @model.reflect_on_all_associations.any? { |c| c.foreign_key == @field.name }
+  end
+
+  def has_validations?
+    # TODO include another validations
+    @model.validators_on(@field.name).any? { |v| !v.options[:in].nil? }
+  end
+end

data/lib/k_seeder/version.rb

@@ -0,0 +1,3 @@
+module KSeeder
+  VERSION = "0.1.0"
+end

data/lib/tasks/seeder.rb

@@ -0,0 +1,20 @@
+namespace :seeder do
+  desc 'Seeds all models'
+  task :seed, [:model] => :environment do |task, args|
+    # defaulting to 10 entries if no value is provided
+    entries = ENV['ENTRIES'].present? ? ENV['ENTRIES'].to_i : 10
+
+    # if no models are received, all are consired
+    if ENV['MODELS'].present?
+      models = ENV['MODELS'].split(',')
+      models.map! { |model| model.capitalize }
+    else
+      Rails.application.eager_load!
+      models = ApplicationRecord.descendants.map { |model| model.to_s }
+    end
+
+    models.each do |model|
+      KSeeder.seed(model, entries)
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: k_seeder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ricardo Marques
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Generic seeder for ActiveRecord rails instances.
+email:
+- ricardo.ds.marques@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- k_seeder.gemspec
+- lib/k_seeder.rb
+- lib/k_seeder/content.rb
+- lib/k_seeder/version.rb
+- lib/tasks/seeder.rb
+homepage: https://github.com/kollegorna/k_seeder
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Generic seeder for ActiveRecord rails instances.
+test_files: []