cuttings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2691d8ba7417ac94552395c47e1a6d0ea792f6a0
+  data.tar.gz: 4c414ee4662e7e642be45e51c980f2c992ee1baf
+SHA512:
+  metadata.gz: 6b34dda19039bfdaca352ae125dede3391f3dc60e56f13cb58adbc5184b6a004f751591568f4a8307596e3426238e854e4b80ae62caf3d1d3d49b5a72ae2d2e2
+  data.tar.gz: df1ed76b541300f76f630081f63143c5446f1fea4f6b8dbe2b1b1536ffac26b48c1f7be309abc225992685d0384e16cba67f19ebfa9e3f68e607ff6cfe8c4e38

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 vala
+
+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,97 @@
+# Cuttings
+
+Cuttings allows you to create seed data with a simple DSL that aims to shorten
+your seeding code and keeping it readable.
+
+Attachment seeding is made to work with Paperclip's way to assing files.
+
+## Installation
+
+Add to your Gemfile and `bundle install` :
+
+```ruby
+gem 'cuttings'
+```
+
+## Usage
+
+In your `db/seeds.rb` or in a `rake` task :
+
+```ruby
+require 'cuttings'
+
+Cuttings.plant do
+  truncate %w(Visit)
+
+  seed 'User' do
+    create(
+      name: 'Jean Jean',
+      email: 'jean@jean.com',
+      avatar: attachment('user.png')
+    )
+  end
+end
+```
+
+## DSL
+
+The DSL is quite simple, and gives you just the tools you need to get a
+clean and readable seed file.
+
+### Emptying models
+
+To empty model tables, you can use the `#truncate` method followed by a list
+of model names.
+
+This is used to empty tables from models you won't seed, and is equivalent to
+calling `.destroy_all` on all provided models.
+
+```ruby
+Cuttings.plant do
+  truncate %w(Visit)
+end
+```
+
+### Seeding models
+
+To seed a model, you'll use the `#seed` method.
+The `#seed` method automatically truncates the table of the model.
+If you don't want it to do so, you can pass `truncate: false` as the second
+argument.
+
+```ruby
+seed 'User', truncate: false do
+  ...
+end
+```
+
+To create your model's instances, you'll have to call `#create` inside the
+`#seed` method block, and give it a hash of attributes to assign.
+
+```ruby
+seed 'Product' do
+  create(name: 'Rope', price: 12.90)
+end
+```
+
+### Seeding attachments
+
+To seed attachments, start by adding your attachment to your
+`lib/seeds/attachments` folder.
+You'll then be able to use the `#attachment` helper method from inside
+the `#seed` method block to pass it to your model's creation.
+
+```ruby
+seed 'User' do
+  create(
+    name: 'Jean Jean',
+    email: 'jean@jean.com',
+    avatar: attachment('user.png')
+  )
+end
+```
+
+
+## Licence
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cuttings'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/cuttings.rb

@@ -0,0 +1,12 @@
+module Cuttings
+  extend ActiveSupport::Autoload
+
+  autoload :Greenhouse
+  autoload :Cutting
+
+  def self.plant(&block)
+    greenhouse = Cuttings::Greenhouse.new
+    greenhouse.instance_eval(&block)
+    greenhouse.process
+  end
+end

data/lib/cuttings/cutting.rb

@@ -0,0 +1,40 @@
+module Cuttings
+  class Cutting
+    attr_accessor :model_name, :processor
+
+    def initialize(model_name, options = {}, &block)
+      self.model_name = model_name
+      self.processor = block
+    end
+
+    def model
+      @model ||= model_name.constantize
+    end
+
+    def run
+      processor && instance_eval(&processor)
+      close_all_open_files
+    end
+
+    def create(attrs)
+      model.create!(attrs)
+    end
+
+    def attachment(path)
+      file = File.open(Rails.root.join('lib', 'seeds', 'attachments', path))
+      attachment_files << file
+      file
+    end
+
+    private
+
+    def attachment_files
+      @attachment_files ||= []
+    end
+
+    def close_all_open_files
+      attachment_files.each(&:close)
+      attachment_files.clear
+    end
+  end
+end

data/lib/cuttings/greenhouse.rb

@@ -0,0 +1,31 @@
+module Cuttings
+  class Greenhouse
+    def seed(model_name, options = {}, &block)
+      truncatable_models << model_name unless options.delete(:truncate) == false
+      creatable_models << Cutting.new(model_name, options, &block)
+    end
+
+    def truncate(*model_names)
+      truncatable_models.concat(model_names.flatten)
+    end
+
+    def truncatable_models
+      @truncatable_models ||= []
+    end
+
+    def creatable_models
+      @creatable_models ||= []
+    end
+
+    def process
+      truncate_models
+      creatable_models.each(&:run)
+    end
+
+    def truncate_models
+      truncatable_models.each do |model_name|
+        model_name.constantize.destroy_all
+      end
+    end
+  end
+end

data/lib/cuttings/version.rb

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

data/lib/tasks/cuttings_tasks.rake

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: cuttings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  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: Fast & easy seeding for Rails
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/cuttings.rb
+- lib/cuttings/cutting.rb
+- lib/cuttings/greenhouse.rb
+- lib/cuttings/version.rb
+- lib/tasks/cuttings_tasks.rake
+homepage: http://github.com/glyph-fr/cuttings
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Fast & easy seeding for Rails
+test_files: []