sequel-seed 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f6d93c61eea344cdf8319b68f627bc9abf8b97
-  data.tar.gz: 7e3042d71cc4c888924bc7603085dd8606e00a2f
+  metadata.gz: fa4c96943080141c916b61f92f9c1a8757b1de76
+  data.tar.gz: 1286b7fb1157a44fb6ebaa0e0b6c008b410d370e
 SHA512:
-  metadata.gz: b41ae81873403d6688ac393b75859767eac89acbeade98f67724e307c1bf18cf6d51643164581c5baafe07f6b0d4e3b18f76f09b41f6ab22a0256ca3294a92bc
-  data.tar.gz: 243e5ae79b93013e95925b20fc98019b78680be3217a4dfa85f3071c37474bb67f515b9ad9c81df5c13f8045fb456bfd47401d17fffa6607b32619832a4f5df3
+  metadata.gz: 31a90821eaeba184b477f362163d1b6e9c4a6fb4e68833097c11d5dab9a3cec1a678f6f0aff776753ad7e2b86239ea4602251ae1bdb898da34e8fdb61f79709c
+  data.tar.gz: e27f4f75326aa710e6ff337f8d9d99fd0a21285c5f829c13c77a088d284ec32a35a64b1f0282284fdad3aaf5555bdb4c88303f4a76266e47d30b87a55ab9ff0e

data/CHANGELOG

@@ -1 +1,10 @@
 ## Changelog
+
+### 0.1.4
+- Environment references could be a Symbol or String
+- Improve test coverage
+- New project website with documentation
+
+### 0.1.2
+- Initial version
+- Seed descriptor only available as Ruby code

data/README.md

@@ -1,22 +1,13 @@
-# Sequel::Seed
+# Sequel::Seed [![Gem Version](https://badge.fury.io/rb/sequel-seed.svg)](http://badge.fury.io/rb/sequel-seed)
 
 > A Sequel extension to make seeds/fixtures manageable like migrations
 
 ## Usage
 
-Load the extension
-
-```rb
-require 'sequel'
-require 'sequel/extensions/seed'
-
-Sequel.extension :seed
-```
-
-Create a seed file (eg. `/path/to/seeds/20150928071637_currencies`)
+Create a seed file (eg. `/path/to/seeds/20150928071637_currencies.rb`)
 
 ```rb
-Sequel.seed(:development, :test, :production) do
+Sequel.seed(:development, :test) do # Applies only to "development" and "test" environments
   def run
     [
       ['USD', 'United States dollar'],
@@ -34,6 +25,15 @@ Set the environment
 Sequel::Seed.environment = :development
 ```
 
+Load the extension
+
+```rb
+require 'sequel'
+require 'sequel/extensions/seed'
+
+Sequel.extension :seed
+```
+
 Apply the seeds/fixtures
 
 ```rb
@@ -41,10 +41,21 @@ DB = Sequel.connect(...)
 Sequel::Seeder.apply(DB, "/path/to/seeds")
 ```
 
+For more information, please check the [project website](//github.com/earaujoassis/sequel-seed/).
+
 ## Limitations
 
 Only timestamped seeds files
 
+## What's next?
+
+JSON & YAML files as fixtures/seeds
+
+## Support
+
+If you need any help (or have found any bug 🐞), please post it on
+[/issues](//github.com/earaujoassis/sequel-seed/issues). Thank you!
+
 ## License
 
 [MIT License](http://earaujoassis.mit-license.org/) © Ewerton Assis

data/lib/sequel/extensions/seed.rb

@@ -1,18 +1,22 @@
+##
 # Extension based upon Sequel::Migration and Sequel::Migrator
 #
 # Adds the Sequel::Seed and Sequel::Seeder classes, which allow
-# the user to easily group entity changes and seed the database
-# to a newer version only (migrations are directional, up or down;
-# seeds are always applied).
+# the user to easily group entity changes and seed/fixture the database
+# to a newer version only (unlike migrations, seeds are not directional).
 #
 # To load the extension:
 #
 #   Sequel.extension :seed
+#
+# It is also important to set the environment:
+#
+#   Sequel::Seed.environment = :development
 
 module Sequel
   class Seed
     class << self
-      attr_accessor :environment
+      attr_reader :environment
     end
 
     def self.apply
@@ -27,21 +31,62 @@ module Sequel
       descendants << base
     end
 
+    def self.environment=(env)
+      @environment = env.to_sym
+    end
+
     def run
     end
   end
 
+  ##
+  # Creates a Seed subclass according to the given +block+.
+  #
+  # The +env_labels+ lists on which environments the seed should be applicable.
+  # If the current environment is not applicable, the seed is ignored. On the
+  # other hand, if it is applicable, it will be listed in Seed.descendants and
+  # subject to application (if it was not applied yet).
+  #
+  # Expected seed call:
+  #
+  #   Sequel.seed(:test) do # seed is only applicable to the test environment
+  #     def run
+  #       Entity.create attribute: value
+  #     end
+  #   end
+  #
+  # Wildcard seed:
+  #
+  #   Sequel.seed do # seed is applicable to every environment, or no environment
+  #     def run
+  #       Entity.create attribute: value
+  #     end
+  #   end
+  #
+
   def self.seed *env_labels, &block
-    return if env_labels.length > 0 && !env_labels.include?(Seed.environment)
+    return if env_labels.length > 0 && !env_labels.map(&:to_sym).include?(Seed.environment)
 
     seed = Class.new(Seed)
     seed.class_eval(&block) if block_given?
-    Seed.inherited(seed) unless Seed.descendants.include? seed
+    Seed.inherited(seed) unless Seed.descendants.include?(seed)
     seed
   end
 
+  ##
+  # Class resposible for applying all the seeds related to the current environment,
+  # if and only if they were not previously applied.
+  #
+  # To apply the seeds/fixtures:
+  #
+  #   Sequel::Seeder.apply(db, directory)
+  #
+  # +db+ holds the Sequel database connection
+  #
+  # +directory+ the path to the seeds/fixtures files
+
   class Seeder
-    SEED_FILE_PATTERN = /\A(\d+)_.+\.rb\z/i.freeze
+    SEED_FILE_PATTERN = /\A(\d+)_.+\.(rb|json|yml)\z/i.freeze
     SEED_SPLITTER = '_'.freeze
     MINIMUM_TIMESTAMP = 20000101
 
@@ -61,7 +106,7 @@ module Sequel
           next unless SEED_FILE_PATTERN.match(file)
           return TimestampSeeder if file.split(SEED_SPLITTER, 2).first.to_i > MINIMUM_TIMESTAMP
         end
-        raise(Error, 'seeder not available for files')
+        raise(Error, "seeder not available for files")
       else
         self
       end
@@ -120,6 +165,18 @@ module Sequel
     end
   end
 
+  ##
+  # A Seeder subclass to apply timestamped seeds/fixtures files.
+  # It follows the same syntax & semantics for the Seeder superclass.
+  #
+  # To apply the seeds/fixtures:
+  #
+  #   Sequel::TimestampSeeder.apply(db, directory)
+  #
+  # +db+ holds the Sequel database connection
+  #
+  # +directory+ the path to the seeds/fixtures files
+
   class TimestampSeeder < Seeder
     DEFAULT_SCHEMA_COLUMN = :filename
     DEFAULT_SCHEMA_TABLE = :schema_seeds

data/spec/extensions/seed_spec.rb

@@ -4,20 +4,17 @@ Sequel::Seed.environment = :test
 
 describe Sequel.seed do
   it 'should create a Seed descendant according to the current environment' do
-    seed = Sequel.seed(:test) do
-    end
+    seed = Sequel.seed(:test) {}
     expect(Sequel::Seed.descendants).to include seed
   end
 
   it 'should ignore a Seed not applicable to the current environment' do
-    seed = Sequel.seed(:development) do
-    end
+    seed = Sequel.seed(:development) {}
     expect(Sequel::Seed.descendants).not_to include seed
   end
 
   it 'should create a Seed applicable to every environment' do
-    seed = Sequel.seed do
-    end
+    seed = Sequel.seed {}
     expect(Sequel::Seed.descendants).to include seed
   end
 end
@@ -25,6 +22,98 @@ end
 describe Sequel::Seeder do
   let(:DB) {Sequel.sqlite}
 
+  describe 'environment references should be indistinguishable between Symbol and String' do
+    context 'when the environment is defined using a String' do
+      it 'should apply the Seed accordingly' do
+        Sequel::Seed.environment = "test"
+
+        Sequel.seed(:test) do
+          def run
+            SpecModel.create :name => 'environment defined by String'
+          end
+        end
+
+        expect(Sequel::Seed.descendants.length).to be 1
+        expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
+        expect(Sequel::Seed.descendants.length).to be 0
+        expect(SpecModel.dataset.all.length).to be 1
+        expect(SpecModel.dataset.first.name).to eq 'environment defined by String'
+      end
+    end
+
+    context 'when the Seed is defined using a String' do
+      it 'should apply the Seed accordingly' do
+        Sequel::Seed.environment = :test
+
+        Sequel.seed("test") do
+          def run
+            SpecModel.create :name => 'Seed defined by String'
+          end
+        end
+
+        expect(Sequel::Seed.descendants.length).to be 1
+        expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
+        expect(Sequel::Seed.descendants.length).to be 0
+        expect(SpecModel.dataset.all.length).to be 1
+        expect(SpecModel.dataset.first.name).to eq 'Seed defined by String'
+      end
+    end
+
+    context 'when both Seed and environment are defined using a String' do
+      it 'should apply the Seed accordingly' do
+        Sequel::Seed.environment = "test"
+
+        Sequel.seed("test") do
+          def run
+            SpecModel.create :name => 'Seed and environment defined by String'
+          end
+        end
+
+        expect(Sequel::Seed.descendants.length).to be 1
+        expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
+        expect(Sequel::Seed.descendants.length).to be 0
+        expect(SpecModel.dataset.all.length).to be 1
+        expect(SpecModel.dataset.first.name).to eq 'Seed and environment defined by String'
+      end
+    end
+
+    context 'when both Seed and environment are defined using a Symbol' do
+      it 'should apply the Seed accordingly' do
+        Sequel::Seed.environment = :test
+
+        Sequel.seed(:test) do
+          def run
+            SpecModel.create :name => 'Seed and environment defined by Symbol'
+          end
+        end
+
+        expect(Sequel::Seed.descendants.length).to be 1
+        expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
+        expect(Sequel::Seed.descendants.length).to be 0
+        expect(SpecModel.dataset.all.length).to be 1
+        expect(SpecModel.dataset.first.name).to eq 'Seed and environment defined by Symbol'
+      end
+    end
+
+    context 'when the environment is defined using a String and we have a wildcard Seed' do
+      it 'should apply the Seed accordingly' do
+        Sequel::Seed.environment = "test"
+
+        Sequel.seed do
+          def run
+            SpecModel.create :name => 'Wildcard Seed and environment defined by String'
+          end
+        end
+
+        expect(Sequel::Seed.descendants.length).to be 1
+        expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
+        expect(Sequel::Seed.descendants.length).to be 0
+        expect(SpecModel.dataset.all.length).to be 1
+        expect(SpecModel.dataset.first.name).to eq 'Wildcard Seed and environment defined by String'
+      end
+    end
+  end
+
   context 'when there\'s no Seed created' do
     it 'should not make any change to the database' do
       expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
@@ -36,7 +125,7 @@ describe Sequel::Seeder do
     it 'should change the database accordingly only once' do
       Sequel.seed do
         def run
-          SpecModel.create name: 'some name'
+          SpecModel.create :name => 'should have changed'
         end
       end
 
@@ -44,21 +133,18 @@ describe Sequel::Seeder do
       expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
       expect(Sequel::Seed.descendants.length).to be 0
       expect(SpecModel.dataset.all.length).to be 1
-      expect(SpecModel.dataset.first.name).to eq 'some name'
+      expect(SpecModel.dataset.first.name).to eq 'should have changed'
     end
   end
 
   context 'when the specified Seed is not applicable to the current environment' do
-    let(:seed) {
+    it 'should not make any change to the database' do
       Sequel.seed(:hithere) do
         def run
-          SpecModel.create name: 'some name'
+          SpecModel.create :name => 'should not have changed'
         end
       end
-    }
 
-    it 'should not make any change to the database' do
-      seed
       expect(Sequel::Seed.descendants.length).to be 0
       expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
       expect(SpecModel.dataset.all.length).to be 0

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'bundler/setup'
 Bundler.setup(:default, :development)
 
 require 'sequel'
+require 'faker'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/sequel/extensions/seed.rb')
 
 RSpec.configure do |config|
@@ -42,7 +43,7 @@ RSpec.configure do |config|
 
   DB.create_table(:spec_models) do
     primary_key :id, :auto_increment => true
-    String   :name
+    String :name
   end
 
   config.before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-seed
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Ewerton Assis