seed_box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bad40ea79b6c5e6479745b3ff42f04da500f9036
+  data.tar.gz: 935d219e758a0dddda8c3b372171312f0a099b64
+SHA512:
+  metadata.gz: 6c06c6ee00d8a6508b5f4478b13b8b12d79278abc3f17b43b8ecf4cb6b8198ab40dfd91920c1c3a49589ccd0aa689b07b1ec293a547169da3ac1af70349891f4
+  data.tar.gz: 73a9cc6f9519448b37d09eaa2913affa445d12d434d87e23397db7124287a07fd896c48470b30ffb0b66e8bd622e7ad968f4ab8967c010fa046744dfba3b8da2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/test.sqlite3
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seed_box.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,94 @@
+[![Build Status](https://travis-ci.org/panter/seed_box.svg?branch=master)](https://travis-ci.org/panter/seed_box)
+
+# SeedBox
+
+Provides omnipotent seeds for rails.
+
+Enhances the standard rails seeds and the rake tasks with helper methods to
+enable omnipotent and easier maintenance of seeds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seed_box'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seed_box
+
+## Usage
+
+### Seed helpers
+
+You can use the helper methods directly in your `seeds.rb`.
+
+* `seed(model, find_or_create_by, update_with = {})`
+
+
+  Finds the `model` record by the attributes provided by `find_or_create_by` or
+  creates a new record if it doesn't exist yet. The attributes provided by
+  `update_with` are updated in any case.
+
+* `seed_once(model, find_or_create_by, create_with = {})`
+
+
+  Finds the `model` record by the attributes provided by `find_or_create_by` or
+  creates a new record if it doesn't exist yet. The attributes provided by
+  `create_with` are only applied the first time, when the record gets created.
+
+* `seed_file(name)`
+
+
+  Seeds a file, whereas the `name` is the file name. The path root is
+  `Rails.root.join('db/seeds')`.
+
+Example:
+
+```ruby
+seed User, { email: 'job@bluth.com' }, {
+  first_name: 'Gob',
+  last_name: 'Bluth',
+  avatar: seed_file('gob.jpg')
+}
+```
+
+### Development / Production seeds
+
+This gem also provides a separation between development and production seeds. Usually the production seeds are a subset of the development seeds.
+
+Additionally to the standard rails rake task `db:seed` there is
+`db:seed:production` which loads the seeds from the file
+`db/seeds.production.rb` if it exists.
+
+The rake task `db:seed` loads the seeds from `db/seeds.production.rb` if it
+exists as well.
+
+The following list summarizes the different seeds:
+
+* `rake db:seed`
+
+
+  loads `db/seeds.production.rb` (if it exists) and
+  `db/seeds.rb`
+
+* `rake db:seed:production`
+
+
+   loads `db/seeds.production.rb` (if it exists)
+
+## 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/panter/seed_box.

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 "seed_box"
+
+# 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/lib/seed_box/railtie.rb

@@ -0,0 +1,7 @@
+module SeedBox
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/seed_box.rake'
+    end
+  end
+end

data/lib/seed_box/version.rb

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

data/lib/seed_box.rb

@@ -0,0 +1,37 @@
+require 'rails'
+require 'active_record'
+
+require 'seed_box/version'
+require 'seed_box/railtie'
+
+module SeedBox
+  def seed(model, find_or_create_by, update_with = {})
+    record = model.where(find_or_create_by).first_or_initialize
+
+    record.update_attributes(update_with)
+
+    handle_errors(record, find_or_create_by, update_with)
+  end
+
+  def seed_once(model, find_or_create_by, create_with = {})
+    record = model.where(find_or_create_by).first_or_initialize(create_with)
+
+    record.save
+
+    handle_errors(record, find_or_create_by, create_with)
+  end
+
+  def seed_file(name)
+    File.new(Rails.root.join('db/seeds').join(name))
+  end
+
+  private
+
+  def handle_errors(record, find_or_create_by, update_with)
+    return record if record.valid?
+
+    raise "Couldn't save #{record.class} " +
+      "(#{record.errors.full_messages.join(', ')}) with provided data: " +
+      "#{find_or_create_by.inspect}, #{update_with.inspect}"
+  end
+end

data/lib/tasks/seed_box.rake

@@ -0,0 +1,20 @@
+namespace :db do
+  # * define a helper to have the methods included in the seeds files directly
+  # * additionally to the normal rails seeds, the production seeds are also
+  #   included
+  desc 'Load the seed data from db/seeds.production.rb'
+  task seed: [:seed_helper, :'seed:production']
+
+  namespace :seed do
+    desc 'Load the seed data from db/seeds.production.rb'
+    task production: [:environment, :seed_helper] do
+      file = Rails.root.join('db/seeds.production.rb')
+      load file if File.exist?(file)
+    end
+  end
+
+  task :seed_helper do
+    require 'seed_box'
+    include SeedBox
+  end
+end

data/seed_box.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seed_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'seed_box'
+  spec.version       = SeedBox::VERSION
+  spec.authors       = ['Alexis Reigel']
+  spec.email         = ['mail@koffeinfrei.org']
+
+  spec.summary       = %q{Provides omnipotent seeds for rails.}
+  spec.description   = %q{Enhances the standard rails seeds and the rake tasks
+                          with helper methods to enable omnipotent and easier
+                          maintenance of seeds.}
+  spec.homepage      = "https://github.com/panter/seed_box"
+  spec.license       = "LGPL-3.0"
+
+  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_runtime_dependency 'rails', '~> 4'
+  spec.add_runtime_dependency 'activerecord', '~> 4'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: seed_box
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexis Reigel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: |-
+  Enhances the standard rails seeds and the rake tasks
+                            with helper methods to enable omnipotent and easier
+                            maintenance of seeds.
+email:
+- mail@koffeinfrei.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/seed_box.rb
+- lib/seed_box/railtie.rb
+- lib/seed_box/version.rb
+- lib/tasks/seed_box.rake
+- seed_box.gemspec
+homepage: https://github.com/panter/seed_box
+licenses:
+- LGPL-3.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides omnipotent seeds for rails.
+test_files: []
+has_rdoc: