sequel-seed 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa4c96943080141c916b61f92f9c1a8757b1de76
-  data.tar.gz: 1286b7fb1157a44fb6ebaa0e0b6c008b410d370e
+  metadata.gz: f5a1af2b07c026c54b028ea8b4153e4523a44faa
+  data.tar.gz: 1e1a6ed02f2cf6b09f9f7e30c54e8eb36e2004e3
 SHA512:
-  metadata.gz: 31a90821eaeba184b477f362163d1b6e9c4a6fb4e68833097c11d5dab9a3cec1a678f6f0aff776753ad7e2b86239ea4602251ae1bdb898da34e8fdb61f79709c
-  data.tar.gz: e27f4f75326aa710e6ff337f8d9d99fd0a21285c5f829c13c77a088d284ec32a35a64b1f0282284fdad3aaf5555bdb4c88303f4a76266e47d30b87a55ab9ff0e
+  metadata.gz: 5c10ccb47562c8bb4b6436a81220ebb9f8f88d6abca4388e6c6aa2350eb6f86a83feb97e20c7272817ca43479abf6c1086a7c2db476b8c02487ba5ccce85dcca
+  data.tar.gz: ba11dee2ccb4b7ccb28b05a0e79897462764e5701a33adc7430e886fe9f664992ae7c6c031034d40fbea2cba9f1f8def3d11159fb4ad462190889e01ae46b62f

data/CHANGELOG

@@ -1,5 +1,14 @@
 ## Changelog
 
+### 0.2.1
+- API changes to protect Sequel's namespace
+- `Sequel::Seed.environment = :env` is also `Sequel::Seed.setup(:env)`
+- `Sequel::Seed` class is now `Sequel::Seed::Base`; `Sequel::Seed` is now a module;
+thus, there's no way to proxy the old `Sequel::Seed.apply` to the new `Sequel::Seed::Base.apply`
+- `Sequel::Seeder` and `Sequel::TimestampSeeder` are still the same (no changes in interface as well)
+- Improve test coverage to guarantee backward compatibility
+- Minor hotfixes
+
 ### 0.1.4
 - Environment references could be a Symbol or String
 - Improve test coverage

data/README.md

@@ -1,4 +1,4 @@
-# Sequel::Seed [![Gem Version](https://badge.fury.io/rb/sequel-seed.svg)](http://badge.fury.io/rb/sequel-seed)
+# Sequel::Seed [![Gem Version](https://badge.fury.io/rb/sequel-seed.svg)](http://badge.fury.io/rb/sequel-seed) [![Build Status](https://travis-ci.org/earaujoassis/sequel-seed.svg?branch=master)](https://travis-ci.org/earaujoassis/sequel-seed) [![Coverage Status](https://coveralls.io/repos/earaujoassis/sequel-seed/badge.svg?branch=master&service=github)](https://coveralls.io/github/earaujoassis/sequel-seed?branch=master)
 
 > A Sequel extension to make seeds/fixtures manageable like migrations
 
@@ -22,7 +22,7 @@ end
 Set the environment
 
 ```rb
-Sequel::Seed.environment = :development
+Sequel::Seed.setup :development
 ```
 
 Load the extension

data/lib/sequel/extensions/seed.rb

@@ -1,9 +1,10 @@
 ##
 # 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/fixture the database
-# to a newer version only (unlike migrations, seeds are not directional).
+# Adds the Sequel::Seed module and the Sequel::Seed::Base and Sequel::Seeder
+# classes, which allow 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:
 #
@@ -11,79 +12,109 @@
 #
 # It is also important to set the environment:
 #
-#   Sequel::Seed.environment = :development
+#   Sequel::Seed.setup(:development)
 
 module Sequel
-  class Seed
+  class << self
+    ##
+    # 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 seed *env_labels, &block
+      return if env_labels.length > 0 && !env_labels.map(&:to_sym).include?(Seed.environment)
+
+      seed = Class.new(Seed::Base)
+      seed.class_eval(&block) if block_given?
+      Seed::Base.inherited(seed) unless Seed::Base.descendants.include?(seed)
+      seed
+    end
+  end
+
+  module Seed
     class << self
       attr_reader :environment
-    end
 
-    def self.apply
-      new.run
-    end
+      ##
+      # Sets the Sequel::Seed's environment to +env+ over which the Seeds should be applied
+      def setup(env, opts = {})
+        @environment = env.to_sym
+        @options ||= {}
+        @options[:disable_warning] ||= opts[:disable_warning] || false
+      end
 
-    def self.descendants
-      @descendants ||= []
-    end
+      ##
+      # Keep backward compatibility on how to setup the Sequel::Seed environment
+      #
+      # Sets the environment +env+ over which the Seeds should be applied
+      def environment=(env)
+        setup(env)
+      end
 
-    def self.inherited(base)
-      descendants << base
-    end
+      ##
+      # Keep backward compatibility on how to get Sequel::Seed::Base class descendants
+      def descendants
+        Base.descendants
+      end
 
-    def self.environment=(env)
-      @environment = env.to_sym
+      ##
+      # Keep backward compatibility on how to append a Sequel::Seed::Base descendant class
+      def inherited(base)
+        Base.inherited(base)
+      end
     end
 
-    def run
-    end
-  end
+    class Base
+      class << self
+        def apply
+          new.run
+        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 descendants
+          @descendants ||= []
+        end
 
-  def self.seed *env_labels, &block
-    return if env_labels.length > 0 && !env_labels.map(&:to_sym).include?(Seed.environment)
+        def inherited(base)
+          descendants << base
+        end
+      end
 
-    seed = Class.new(Seed)
-    seed.class_eval(&block) if block_given?
-    Seed.inherited(seed) unless Seed.descendants.include?(seed)
-    seed
-  end
+      def run
+      end
+    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 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
+  end
 
   class Seeder
     SEED_FILE_PATTERN = /\A(\d+)_.+\.(rb|json|yml)\z/i.freeze
@@ -106,7 +137,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; please checked the directory")
       else
         self
       end
@@ -154,10 +185,10 @@ module Sequel
     end
 
     def remove_seed_classes
-      Seed.descendants.each do |c|
+      Seed::Base.descendants.each do |c|
         Object.send(:remove_const, c.to_s) rescue nil
       end
-      Seed.descendants.clear
+      Seed::Base.descendants.clear
     end
 
     def seed_version_from_file(filename)
@@ -230,14 +261,14 @@ module Sequel
     def get_seed_tuples
       remove_seed_classes
       seeds = []
-      ms = Seed.descendants
+      ms = Seed::Base.descendants
       files.each do |path|
         f = File.basename(path)
         fi = f.downcase
         if !applied_seeds.include?(fi)
           load(path)
           el = [ms.last, f]
-          if ms.last.present? && !seeds.include?(el)
+          if !ms.last.nil? && !seeds.include?(el)
             seeds << [ms.last, f]
           end
         end

data/spec/extensions/seed_spec.rb

@@ -1,152 +1,211 @@
 require 'spec_helper'
 
-Sequel::Seed.environment = :test
-
 describe Sequel.seed do
+  before do
+    Sequel::Seed.setup(:test)
+  end
+
   it 'should create a Seed descendant according to the current environment' do
     seed = Sequel.seed(:test) {}
-    expect(Sequel::Seed.descendants).to include seed
+    expect(Sequel::Seed::Base.descendants).to include seed
   end
 
   it 'should ignore a Seed not applicable to the current environment' do
     seed = Sequel.seed(:development) {}
-    expect(Sequel::Seed.descendants).not_to include seed
+    expect(Sequel::Seed::Base.descendants).not_to include seed
   end
 
   it 'should create a Seed applicable to every environment' do
     seed = Sequel.seed {}
-    expect(Sequel::Seed.descendants).to include seed
+    expect(Sequel::Seed::Base.descendants).to include seed
+  end
+end
+
+describe Sequel::Seed.environment do
+  it 'should be possible to set the environment with Sequel::Seed.setup method' do
+    Sequel::Seed.setup(:mock)
+    expect(Sequel::Seed.environment).to eq :mock
+    Sequel::Seed.setup("test")
+    expect(Sequel::Seed.environment).to eq :test
+  end
+
+  it 'should be possible to set the environment with Sequel::Seed.environment= method' do
+    Sequel::Seed.environment = :mock
+    expect(Sequel::Seed.environment).to eq :mock
+    Sequel::Seed.environment = "test"
+    expect(Sequel::Seed.environment).to eq :test
+  end
+end
+
+describe Sequel::Seed do
+  describe "to guarantee backward compatibility" do
+    it "should point Sequel::Seed.descendants to Sequel::Seed::Base.descendants" do
+      Sequel::Seed::Base.descendants << 'hi'
+      expect(Sequel::Seed.descendants).to contain_exactly('hi')
+    end
+
+    it "should point Sequel::Seed.inherited() to Sequel::Seed::Base.inherited()" do
+      Sequel::Seed::Base.inherited('1')
+      Sequel::Seed.inherited('2')
+      expect(Sequel::Seed.descendants).to contain_exactly('1', '2')
+    end
   end
 end
 
 describe Sequel::Seeder do
   let(:DB) {Sequel.sqlite}
+  let!(:environment) {"#{Faker::Lorem.word}_#{Faker::Lorem.word}"}
+
+  it "should raise an error when there is not any seed file to apply" do
+    Sequel::Seed.setup environment
+
+    expect(Sequel::Seed::Base.descendants.length).to be 0
+    expect {Sequel::Seeder.apply(DB, '/')}.to raise_error("seeder not available for files; please checked the directory")
+    expect(SpecModel.dataset.all.length).to be 0
+  end
 
   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
+        Sequel::Seed.setup environment
+
+        File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+          f.puts "Sequel.seed(:#{environment}) do"
+          f.puts '  def run'
+          f.puts '    SpecModel.create :sentence => \'environment defined by String\''
+          f.puts '  end'
+          f.puts '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(Sequel::Seed::Base.descendants.length).to be 0
+        expect(Sequel::Seeder.seeder_class(seed_test_dir)).to be Sequel::TimestampSeeder
+        expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+        expect(Sequel::Seed::Base.descendants.length).to be 1
         expect(SpecModel.dataset.all.length).to be 1
-        expect(SpecModel.dataset.first.name).to eq 'environment defined by String'
+        expect(SpecModel.dataset.first.sentence).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
+        Sequel::Seed.setup environment.to_sym
+
+        File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+          f.puts "Sequel.seed(\"#{environment}\") do"
+          f.puts '  def run'
+          f.puts '    SpecModel.create :sentence => \'Seed defined by String\''
+          f.puts '  end'
+          f.puts '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(Sequel::Seed::Base.descendants.length).to be 0
+        expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+        expect(Sequel::Seed::Base.descendants.length).to be 1
         expect(SpecModel.dataset.all.length).to be 1
-        expect(SpecModel.dataset.first.name).to eq 'Seed defined by String'
+        expect(SpecModel.dataset.first.sentence).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
+        Sequel::Seed.setup environment
+
+        File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+          f.puts "Sequel.seed(\"#{environment}\") do"
+          f.puts '  def run'
+          f.puts '    SpecModel.create :sentence => \'Seed and environment defined by String\''
+          f.puts '  end'
+          f.puts '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(Sequel::Seed::Base.descendants.length).to be 0
+        expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+        expect(Sequel::Seed::Base.descendants.length).to be 1
         expect(SpecModel.dataset.all.length).to be 1
-        expect(SpecModel.dataset.first.name).to eq 'Seed and environment defined by String'
+        expect(SpecModel.dataset.first.sentence).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
+        Sequel::Seed.setup environment.to_sym
+
+        File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+          f.puts "Sequel.seed(:#{environment}) do"
+          f.puts '  def run'
+          f.puts '    SpecModel.create :sentence => \'Seed and environment defined by Symbol\''
+          f.puts '  end'
+          f.puts '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(Sequel::Seed::Base.descendants.length).to be 0
+        expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+        expect(Sequel::Seed::Base.descendants.length).to be 1
         expect(SpecModel.dataset.all.length).to be 1
-        expect(SpecModel.dataset.first.name).to eq 'Seed and environment defined by Symbol'
+        expect(SpecModel.dataset.first.sentence).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
+        Sequel::Seed.setup environment
+
+        File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+          f.puts 'Sequel.seed do'
+          f.puts '  def run'
+          f.puts '    SpecModel.create :sentence => \'Wildcard Seed and environment defined by String\''
+          f.puts '  end'
+          f.puts '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(Sequel::Seed::Base.descendants.length).to be 0
+        expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+        expect(Sequel::Seed::Base.descendants.length).to be 1
         expect(SpecModel.dataset.all.length).to be 1
-        expect(SpecModel.dataset.first.name).to eq 'Wildcard Seed and environment defined by String'
+        expect(SpecModel.dataset.first.sentence).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
-      expect(SpecModel.dataset.all.length).to be 0
-    end
-  end
-
   context 'when there\'s a Seed created' do
     it 'should change the database accordingly only once' do
-      Sequel.seed do
-        def run
-          SpecModel.create :name => 'should have changed'
-        end
+      Sequel::Seed.setup environment
+
+      File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+        f.puts 'Sequel.seed do'
+        f.puts '  def run'
+        f.puts '    SpecModel.create :sentence => \'should have changed\''
+        f.puts '  end'
+        f.puts '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(Sequel::Seed::Base.descendants.length).to be 0
+      expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+      expect(Sequel::Seed::Base.descendants.length).to be 1
+      expect(SpecModel.dataset.all.length).to be 1
+      expect(SpecModel.dataset.first.sentence).to eq 'should have changed'
+      # Once again
+      expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
+      expect(Sequel::Seed::Base.descendants.length).to be 0
       expect(SpecModel.dataset.all.length).to be 1
-      expect(SpecModel.dataset.first.name).to eq 'should have changed'
+      expect(SpecModel.dataset.first.sentence).to eq 'should have changed'
     end
   end
 
   context 'when the specified Seed is not applicable to the current environment' do
     it 'should not make any change to the database' do
-      Sequel.seed(:hithere) do
-        def run
-          SpecModel.create :name => 'should not have changed'
-        end
+      Sequel::Seed.setup environment
+
+      File.open("#{seed_test_dir}/#{seed_file_name}", 'w+') do |f|
+        f.puts "Sequel.seed(:another_#{Faker::Lorem.word}_word) do"
+        f.puts '  def run'
+        f.puts '    SpecModel.create :sentence => \'should have changed\''
+        f.puts '  end'
+        f.puts 'end'
       end
 
-      expect(Sequel::Seed.descendants.length).to be 0
-      expect {Sequel::Seeder.apply(DB, '/')}.not_to raise_error
+      expect(Sequel::Seed::Base.descendants.length).to be 0
+      expect {Sequel::Seeder.apply(DB, seed_test_dir)}.not_to raise_error
       expect(SpecModel.dataset.all.length).to be 0
     end
   end

data/spec/spec_helper.rb

@@ -1,56 +1,52 @@
 require 'bundler/setup'
-Bundler.setup(:default, :development)
+Bundler.setup(:default, :development, :test)
+
+require 'coveralls'
+Coveralls.wear!
 
 require 'sequel'
-require 'faker'
 require File.expand_path(File.dirname(__FILE__) + '/../lib/sequel/extensions/seed.rb')
 
-RSpec.configure do |config|
-  Sequel.extension :seed
-
-  class Sequel::Seeder
-    def self.seeder_class(directory)
-      if self.equal?(Sequel::Seeder)
-        return Sequel::TimestampSeeder
-      else
-        self
-      end
-    end
-  end
+require 'faker'
 
-  class Sequel::TimestampSeeder
-    def run
-      seed_tuples.each {|s| s.apply}
-      Sequel::Seed.descendants.clear
+module Sequel::Seed
+  module TestHelper
+    def seed_test_dir
+      @test_dir ||= ENV['TEST_PATH'] || './.testing'
     end
 
-    private
-
-    def get_applied_seeds
-      []
+    def seed_file_name
+      "#{Time.now.strftime('%Y%m%d%H%M%S')}_testing_#{Faker::Lorem.word}_#{Faker::Lorem.word}.rb"
     end
+  end
+end
 
-    def get_seed_files
-      []
-    end
+RSpec.configure do |config|
+  include Sequel::Seed::TestHelper
 
-    def get_seed_tuples
-      Sequel::Seed.descendants
-    end
-  end
+  Sequel.extension :seed
 
   DB = Sequel.sqlite
 
   DB.create_table(:spec_models) do
     primary_key :id, :auto_increment => true
-    String :name
+    String :sentence
+  end
+
+  config.before(:suite) do
+    FileUtils.mkdir_p(seed_test_dir)
   end
 
   config.before(:each) do
     SpecModel.dataset.delete
-    Sequel::Seed.descendants.clear
+    Sequel::Seed::Base.descendants.clear
+    # QUICK FIX: Somehow the dataset models are not excluded fast enough
+    sleep(0.750)
   end
-end
 
-class SpecModel < Sequel::Model
+  config.after(:suite) do
+    FileUtils.remove_dir(seed_test_dir, true)
+  end
 end
+
+class SpecModel < Sequel::Model; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-seed
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Ewerton Assis
@@ -48,7 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="