seedify 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e30b412c681fb0bbe203e5f727f6e8fe07244899
-  data.tar.gz: 9e3756126a3fc222f419ef3c9fbb63388701ad80
+  metadata.gz: 1cb5a60e7806659a97c2a2931e0e1e1920306613
+  data.tar.gz: 6eee00b3687a000ae17412d92687a344bcade309
 SHA512:
-  metadata.gz: 240aa1ee3cf2dd37aaa612f63f4f1502d4e8502753e0ac3dc8d00754aa59601357e9ca690a97a66479bfc1372bb4ef6747dc1ad43a7b2024c9c9e761e7cf6ced
-  data.tar.gz: 3cb870b74192c11a3c0c8277ebe5524435280810de7efadd1ffe0b29b4ccf67fe0a5ef69098e85ca8985c4292d2816848b114d9879c8873a4024c1ff83351aa2
+  metadata.gz: 08a8b1e06d6c7a749ec5fa000dd6c591b47f68f6034e35628a1007f7401eda172fb6d55495721038e0bd4594ae325e326bb99ee44c293bd1746fe91423fd3d3d
+  data.tar.gz: cc5d449ed7b3a37740eba73e6e2fc47d64c10f735797c7d5bd8aaa6c2dec97190f8d376199e5f7d1328a5e6b3b5a0416b0ad4d948e439061f19ff61521564539

data/README.md

@@ -6,17 +6,31 @@
 [![Code Climate](https://img.shields.io/codeclimate/github/visualitypl/seedify.svg?style=flat-square)](https://codeclimate.com/github/visualitypl/seedify)
 [![Test Coverage](https://img.shields.io/codeclimate/coverage/github/visualitypl/seedify.svg?style=flat-square)](https://codeclimate.com/github/visualitypl/seedify)
 
-Let your seed code become a first-class member of the Rails app and put it into seed objects. **seedify** allows to implement and organize seeds in object-oriented fashion, putting them into `app/seeds` alongside the controllers, models etc. It also provides handy syntax for command line parameters and progress logging.
+Let your seed code become a first-class member of the Rails app and put it into seed objects. **seedify** allows to implement and organize seeds in object-oriented fashion, putting them into `db/seeds` which organizes seeds much like `app/models` does with models etc. It also provides handy syntax for command line parameters and progress logging.
 
 Here's an overview of what you can achieve with **seedify**:
 
 - organize seed code in object-oriented, Rails convention fitting fashion
 - take advantage of inheritance and modularization when writing seeds
-- invoke seeds as rake tasks or from within the app/console
+- invoke seeds as rake tasks or from within the db/console
 - allow to specify custom parameters for your seeds, typed and with defaults
 - log the seed progress (e.g. mass creation) without effort
 - combine with [factory_girl](https://github.com/thoughtbot/factory_girl) to simplify object creation and share fixtures with specs
 
+## Installation
+
+First, add **seedify** to `Gemfile`. Be sure to add it just to group(s) you'll actually use it in:
+
+```ruby
+gem 'seedify', group: 'development'
+```
+
+Then run:
+
+```sh
+bundle install
+```
+
 ## Usage
 
 ### Basic example
@@ -24,7 +38,7 @@ Here's an overview of what you can achieve with **seedify**:
 You should start by implementing the `ApplicationSeed` class:
 
 ```ruby
-# app/seeds/application_seed.rb
+# db/seeds/application_seed.rb
 class ApplicationSeed < Seedify::Base
   def call
     if Admin.empty?
@@ -183,7 +197,7 @@ end
 You can separate the seed code into domains that fit your application best (including modules). In this case, we'll create model-oriented seeds for `Admin` and `User` models and keep application-wide code and param readers in application seed:
 
 ```ruby
-# app/seeds/application_seed.rb
+# db/seeds/application_seed.rb
 class ApplicationSeed < Seed::Base
   include FactoryGirl::Syntax::Methods
 
@@ -208,7 +222,7 @@ end
 ```
 
 ```ruby
-# app/seeds/admin_seed.rb
+# db/seeds/admin_seed.rb
 class AdminSeed < ApplicationSeed
   param_reader :admin_email, default: 'admin@example.com'
 
@@ -223,7 +237,7 @@ end
 ```
 
 ```ruby
-# app/seeds/user_seed.rb
+# db/seeds/user_seed.rb
 class UserSeed < ApplicationSeed
   param_reader :user_prefix, default: 'user'
   param_reader :user_count,  type: :integer, default: 5
@@ -254,12 +268,23 @@ You should try to write each seed object in a way that makes it possible to use
 You can customize sub-seed invocation with a syntax you already know - the call parameters:
 
 ```ruby
-# excerpt from app/seeds/application_seed.rb
+# excerpt from db/seeds/application_seed.rb
 UserSeed.call user_prefix: 'user_generated_by_app_seed'
 ```
 
 This way, within **UserSeed**, the `user_prefix` param will equal to *user_generated_by_app_seed* regardless of the one specified when calling the application seed from console or command-line.
 
+## Configuration
+
+You can override the default `db/seeds` seed directory if you want to place your seed objects in different place in the project:
+
+```ruby
+# excerpt from config/application.rb
+config.seedify_seed_directory = "#{config.root}/app/seeds"
+```
+
+Remember that everything you put into `app/*` gets preloaded in production so putting your seeds there makes sense only if you actually want to use them in production. That's why they live in `db/seeds` by default.
+
 ## Contributing
 
 1. Fork it (https://github.com/visualitypl/seedify/fork)

data/lib/seedify/logger.rb

@@ -2,6 +2,16 @@ module Seedify
   class Logger
     attr_reader :context
 
+    def self.seed_name_formatter(name)
+      name.to_s.sub(/Seed$/, '')
+    end
+
+    def self.max_seed_name_length
+      @max_seed_name_length ||= Seedify::Storage.seed_list.map do |name|
+        seed_name_formatter(name).length
+      end.max
+    end
+
     def initialize(context)
       @context = context
     end
@@ -73,8 +83,8 @@ module Seedify
     end
 
     def name
-      text = context.class.name
-      text = (' ' * [0, Seedify::Storage.max_seed_name_length - text.length].max) + text
+      text = self.class.seed_name_formatter(context.class)
+      text = (' ' * [0, self.class.max_seed_name_length - text.length].max) + text
 
       colorize(text, 32)
     end

data/lib/seedify/railtie.rb

@@ -2,6 +2,10 @@ module Seedify
   class Railtie < Rails::Railtie
     railtie_name :seedify
 
+    initializer 'seedify.autoload', before: :set_autoload_paths do |app|
+      app.config.autoload_paths << Seedify::Storage.seed_directory
+    end
+
     rake_tasks do
       load 'tasks/seedify.rake'
     end

data/lib/seedify/storage.rb

@@ -2,7 +2,11 @@ module Seedify
   module Storage
     class << self
       def seed_directory
-        Rails.root.join('app', 'seeds')
+        begin
+          Rails.application.config.seedify_seed_directory || raise
+        rescue
+          Rails.root.join('db', 'seeds')
+        end
       end
 
       def seed_list
@@ -10,10 +14,6 @@ module Seedify
           ActiveSupport::Inflector.classify(file.sub(/^#{seed_directory.to_s + "/"}/, '').sub(/#{".rb"}$/, ''))
         end
       end
-
-      def max_seed_name_length
-        @max_seed_name_length ||= seed_list.map(&:length).max
-      end
     end
   end
 end

data/lib/seedify/version.rb

@@ -1,3 +1,3 @@
 module Seedify
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seedify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Karol Słuszniak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Implement and organize seeds in Rail-ish, object-oriented fashion. Handy