sequel-seed 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69f6d93c61eea344cdf8319b68f627bc9abf8b97
+  data.tar.gz: 7e3042d71cc4c888924bc7603085dd8606e00a2f
+SHA512:
+  metadata.gz: b41ae81873403d6688ac393b75859767eac89acbeade98f67724e307c1bf18cf6d51643164581c5baafe07f6b0d4e3b18f76f09b41f6ab22a0256ca3294a92bc
+  data.tar.gz: 243e5ae79b93013e95925b20fc98019b78680be3217a4dfa85f3071c37474bb67f515b9ad9c81df5c13f8045fb456bfd47401d17fffa6607b32619832a4f5df3

data/CHANGELOG

@@ -0,0 +1 @@
+## Changelog

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ewerton Assis
+
+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,50 @@
+# 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`)
+
+```rb
+Sequel.seed(:development, :test, :production) do
+  def run
+    [
+      ['USD', 'United States dollar'],
+      ['BRL', 'Brazilian real']
+    ].each do |abbr, name|
+      Currency.create abbr: abbr, name: name
+    end
+  end
+end
+```
+
+Set the environment
+
+```rb
+Sequel::Seed.environment = :development
+```
+
+Apply the seeds/fixtures
+
+```rb
+DB = Sequel.connect(...)
+Sequel::Seeder.apply(DB, "/path/to/seeds")
+```
+
+## Limitations
+
+Only timestamped seeds files
+
+## License
+
+[MIT License](http://earaujoassis.mit-license.org/) © Ewerton Assis

data/lib/sequel/extensions/seed.rb

@@ -0,0 +1,202 @@
+# 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).
+#
+# To load the extension:
+#
+#   Sequel.extension :seed
+
+module Sequel
+  class Seed
+    class << self
+      attr_accessor :environment
+    end
+
+    def self.apply
+      new.run
+    end
+
+    def self.descendants
+      @descendants ||= []
+    end
+
+    def self.inherited(base)
+      descendants << base
+    end
+
+    def run
+    end
+  end
+
+  def self.seed *env_labels, &block
+    return if env_labels.length > 0 && !env_labels.include?(Seed.environment)
+
+    seed = Class.new(Seed)
+    seed.class_eval(&block) if block_given?
+    Seed.inherited(seed) unless Seed.descendants.include? seed
+    seed
+  end
+
+  class Seeder
+    SEED_FILE_PATTERN = /\A(\d+)_.+\.rb\z/i.freeze
+    SEED_SPLITTER = '_'.freeze
+    MINIMUM_TIMESTAMP = 20000101
+
+    class Error < Sequel::Error
+    end
+
+    class NotCurrentError < Error
+    end
+
+    def self.apply(db, directory, opts = {})
+      seeder_class(directory).new(db, directory, opts).run
+    end
+
+    def self.seeder_class(directory)
+      if self.equal?(Seeder)
+        Dir.new(directory).each do |file|
+          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')
+      else
+        self
+      end
+    end
+
+    attr_reader :column
+
+    attr_reader :db
+
+    attr_reader :directory
+
+    attr_reader :ds
+
+    attr_reader :files
+
+    attr_reader :table
+
+    def initialize(db, directory, opts = {})
+      raise(Error, "Must supply a valid seed path") unless File.directory?(directory)
+      @db = db
+      @directory = directory
+      @allow_missing_seed_files = opts[:allow_missing_seed_files]
+      @files = get_seed_files
+      schema, table = @db.send(:schema_and_table, opts[:table]  || self.class.const_get(:DEFAULT_SCHEMA_TABLE))
+      @table = schema ? Sequel::SQL::QualifiedIdentifier.new(schema, table) : table
+      @column = opts[:column] || self.class.const_get(:DEFAULT_SCHEMA_COLUMN)
+      @ds = schema_dataset
+      @use_transactions = opts[:use_transactions]
+    end
+
+    private
+
+    def checked_transaction(seed, &block)
+      use_trans = if @use_transactions.nil?
+        @db.supports_transactional_ddl?
+      else
+        @use_transactions
+      end
+
+      if use_trans
+        db.transaction(&block)
+      else
+        yield
+      end
+    end
+
+    def remove_seed_classes
+      Seed.descendants.each do |c|
+        Object.send(:remove_const, c.to_s) rescue nil
+      end
+      Seed.descendants.clear
+    end
+
+    def seed_version_from_file(filename)
+      filename.split(SEED_SPLITTER, 2).first.to_i
+    end
+  end
+
+  class TimestampSeeder < Seeder
+    DEFAULT_SCHEMA_COLUMN = :filename
+    DEFAULT_SCHEMA_TABLE = :schema_seeds
+
+    Error = Seeder::Error
+
+    attr_reader :applied_seeds
+
+    attr_reader :seed_tuples
+
+    def initialize(db, directory, opts = {})
+      super
+      @applied_seeds = get_applied_seeds
+      @seed_tuples = get_seed_tuples
+    end
+
+    def run
+      seed_tuples.each do |s, f|
+        t = Time.now
+        db.log_info("Begin applying seed #{f}")
+        checked_transaction(s) do
+          s.apply
+          fi = f.downcase
+          ds.insert(column => fi)
+        end
+        db.log_info("Finished applying seed #{f}, took #{sprintf('%0.6f', Time.now - t)} seconds")
+      end
+      nil
+    end
+
+    private
+
+    def get_applied_seeds
+      am = ds.select_order_map(column)
+      missing_seed_files = am - files.map{|f| File.basename(f).downcase}
+      if missing_seed_files.length > 0 && !@allow_missing_seed_files
+        raise(Error, "Applied seed files not in file system: #{missing_seed_files.join(', ')}")
+      end
+      am
+    end
+
+    def get_seed_files
+      files = []
+      Dir.new(directory).each do |file|
+        next unless SEED_FILE_PATTERN.match(file)
+        files << File.join(directory, file)
+      end
+      files.sort_by{|f| SEED_FILE_PATTERN.match(File.basename(f))[1].to_i}
+    end
+
+    def get_seed_tuples
+      remove_seed_classes
+      seeds = []
+      ms = Seed.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)
+            seeds << [ms.last, f]
+          end
+        end
+      end
+      seeds
+    end
+
+    def schema_dataset
+      c = column
+      ds = db.from(table)
+      if !db.table_exists?(table)
+        db.create_table(table){String c, :primary_key => true}
+      elsif !ds.columns.include?(c)
+        raise(Error, "Seeder table #{table} does not contain column #{c}")
+      end
+      ds
+    end
+  end
+end

data/spec/extensions/seed_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+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
+    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
+    expect(Sequel::Seed.descendants).not_to include seed
+  end
+
+  it 'should create a Seed applicable to every environment' do
+    seed = Sequel.seed do
+    end
+    expect(Sequel::Seed.descendants).to include seed
+  end
+end
+
+describe Sequel::Seeder do
+  let(:DB) {Sequel.sqlite}
+
+  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: 'some name'
+        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 'some name'
+    end
+  end
+
+  context 'when the specified Seed is not applicable to the current environment' do
+    let(:seed) {
+      Sequel.seed(:hithere) do
+        def run
+          SpecModel.create name: 'some name'
+        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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require 'bundler/setup'
+Bundler.setup(:default, :development)
+
+require 'sequel'
+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
+
+  class Sequel::TimestampSeeder
+    def run
+      seed_tuples.each {|s| s.apply}
+      Sequel::Seed.descendants.clear
+    end
+
+    private
+
+    def get_applied_seeds
+      []
+    end
+
+    def get_seed_files
+      []
+    end
+
+    def get_seed_tuples
+      Sequel::Seed.descendants
+    end
+  end
+
+  DB = Sequel.sqlite
+
+  DB.create_table(:spec_models) do
+    primary_key :id, :auto_increment => true
+    String   :name
+  end
+
+  config.before(:each) do
+    SpecModel.dataset.delete
+    Sequel::Seed.descendants.clear
+  end
+end
+
+class SpecModel < Sequel::Model
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: sequel-seed
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ewerton Assis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A Sequel extension to make seeds/fixtures manageable like migrations
+email: hello@dearaujoassis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- LICENSE
+- README.md
+- lib/sequel/extensions/seed.rb
+- spec/extensions/seed_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/earaujoassis/sequel-seed
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Sequel extension to make seeds/fixtures manageable like migrations
+test_files: []