cuttings 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2691d8ba7417ac94552395c47e1a6d0ea792f6a0
-  data.tar.gz: 4c414ee4662e7e642be45e51c980f2c992ee1baf
+  metadata.gz: c9867e735e11f82a4e79dbfb8d2d809d43ecee9f
+  data.tar.gz: 2914a5a0cbb9da373fba49d58c7b55e261065085
 SHA512:
-  metadata.gz: 6b34dda19039bfdaca352ae125dede3391f3dc60e56f13cb58adbc5184b6a004f751591568f4a8307596e3426238e854e4b80ae62caf3d1d3d49b5a72ae2d2e2
-  data.tar.gz: df1ed76b541300f76f630081f63143c5446f1fea4f6b8dbe2b1b1536ffac26b48c1f7be309abc225992685d0384e16cba67f19ebfa9e3f68e607ff6cfe8c4e38
+  metadata.gz: f010cc3512589b10722c0a084fae99e288f0404d904e7e29bab0385bc3bc8deb62833928f8a2ebc1013176c72c56b113af699fd4dfa43a4479fbc3cf43d83329
+  data.tar.gz: e319680b8d7f0743e1eff0bfaab831aad03a2b4b431a0b4d4ab6ead9ee4f59f80c9bd4818b17e49c4e059e8048d97b5b0b39690c368f26bb1771487e2bf1ee8d

data/README.md

@@ -13,22 +13,60 @@ Add to your Gemfile and `bundle install` :
 gem 'cuttings'
 ```
 
+Then create the directory structure with the install generator :
+
+```bash
+rails generate cuttings:install
+```
+
 ## Usage
 
-In your `db/seeds.rb` or in a `rake` task :
+Your can use **Cuttings** in your `db/seeds.rb` file, or inside `rake` tasks,
+depending on which method you prefer.
+
+If you choose the `db/seeds.rb` file way, just use the API as explained in the
+**DSL** section.
+
+If you choose the `rake` task way, a generator is provided to help you organize
+your seed tasks.
+
+### Using the `cuttings` generator :
+
+But a generator is provided to help you create separated seed data accessible
+with `rake` tasks.
+
+```bash
+rails generate cuttings users
+```
+
+Which will generate the following file in `lib/seeds/tasks/users.rake`
 
 ```ruby
-require 'cuttings'
+namespace :seed do
+  task users: :environment do
+    Cuttings.plant do
+      # Add your seeding code here
+    end
+  end
+end
+```
 
-Cuttings.plant do
-  truncate %w(Visit)
+### Example usage
 
-  seed 'User' do
-    create(
-      name: 'Jean Jean',
-      email: 'jean@jean.com',
-      avatar: attachment('user.png')
-    )
+```ruby
+namespace :seed do
+  task users: :environment do
+    Cuttings.plant do
+      truncate %w(Visit)
+
+      seed 'User' do
+        create(
+          name: 'Jean Jean',
+          email: 'jean@jean.com',
+          avatar: attachment('user.png')
+        )
+      end
+    end
   end
 end
 ```

data/lib/cuttings.rb

@@ -10,3 +10,5 @@ module Cuttings
     greenhouse.process
   end
 end
+
+require 'cuttings/railtie' if defined?(Rails)

data/lib/cuttings/railtie.rb

@@ -0,0 +1,11 @@
+module Cuttings
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      tasks_path = Rails.root.join('lib', 'seeds', 'tasks', '**', '*.rake')
+
+      Dir[tasks_path].each do |file|
+        load file
+      end
+    end
+  end
+end

data/lib/cuttings/version.rb

@@ -1,3 +1,3 @@
 module Cuttings
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/cuttings/cuttings_generator.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+class CuttingsGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc 'Cuttings install generator'
+
+  def welcome
+    say 'Creating new cuttings ...'
+  end
+
+  def create_folders
+    template 'cuttings.rake', "lib/seeds/tasks/#{ name }.rake"
+  end
+
+  private
+
+  def base_dir
+    @base_dir ||= Rails.root.join('lib', 'seeds')
+  end
+end

data/lib/generators/cuttings/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'fileutils'
+
+module Cuttings
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Cuttings install generator'
+
+    def welcome
+      say 'Installing cuttings ...'
+    end
+
+    def create_folders
+      FileUtils.mkdir_p(base_dir.join('attachments'))
+      FileUtils.mkdir_p(base_dir.join('tasks'))
+    end
+
+    private
+
+    def base_dir
+      @base_dir ||= Rails.root.join('lib', 'seeds')
+    end
+  end
+end

data/lib/generators/cuttings/templates/cuttings.rake

@@ -0,0 +1,7 @@
+namespace :seed do
+  task <%= name %>: :environment do
+    Cuttings.plant do
+      # Add your seeding code here
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuttings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Valentin Ballestrino
@@ -51,7 +51,11 @@ files:
 - lib/cuttings.rb
 - lib/cuttings/cutting.rb
 - lib/cuttings/greenhouse.rb
+- lib/cuttings/railtie.rb
 - lib/cuttings/version.rb
+- lib/generators/cuttings/cuttings_generator.rb
+- lib/generators/cuttings/install/install_generator.rb
+- lib/generators/cuttings/templates/cuttings.rake
 - lib/tasks/cuttings_tasks.rake
 homepage: http://github.com/glyph-fr/cuttings
 licenses: