fixation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e7265052364d7efeb5f95dee6a3aafb4f10d9d0
+  data.tar.gz: 54e03637bb7923633bf96030fc4a8a75e3ceaf08
+SHA512:
+  metadata.gz: c88eba27cc793e2589ec689afac25d0e064c15e3837055eb4d516bfbdf32f30a84673bdf05030b116b9d0e8aa396611bec48f2985cb7f3698d8e77f665236980
+  data.tar.gz: 8c66e7f0dafa4350e5d9a0b1e396d264ba42de3b15de3b2e4c5100cfdb3a784ccd0a627f6b691fbdb06a2fd1090ac25d3000ac235d92a7b62a60bd905162f635

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fixation.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Will Bryant
+
+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,67 @@
+# Fixation
+
+This gem will precompile the SQL statements needed to clear and repopulate your test tables with fixtures when the app boots under spring, so that spec startup just needs to run a small number of multi-row SQL statements to prepare for run.  This takes around 1/10th the time as a normal fixture load.
+
+To avoid any problems when you change your model classes, Fixation avoids loading model classes when it reads your fixture files.  This creates some incompatibilities with normal ActiveRecord fixtures for certain use cases - see Limitations below.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fixation
+
+Then, make an initializer:
+
+    if ENV['PRELOAD_FIXTURES'].to_i > 0 && Rails.env.test?
+      Rails.application.config.after_initialize do
+        require 'spec/fixture_helper'
+        Fixation.build_fixtures
+      end
+    end
+
+And run `spring stop` so this gets picked up.
+
+Finally, open up your spec_helper.rb, and find the current `global_fixtures` setting:
+
+    config.global_fixtures = :all
+
+Change that to [] so that ActiveRecord doesn't load the fixtures again itself, and load the Fixation module:
+
+    config.global_fixtures = []
+    config.include Fixation.fixture_methods
+
+## Usage
+
+Add the PRECOMPILE_FIXTURES=1 option to your spring test commands:
+
+    PRECOMPILE_FIXTURES=1 bundle exec spring spec/models/my_spec.rb
+
+## Limitations
+
+PRECOMPILE_FIXTURES is not on by default in our suggested initializer above, because you don't want it set when running rake tasks like `db:create` and `db:test:prepare` - the initializer above will asplode if you do.  This is one of the biggest drawbacks of this version of the gem.
+
+Because Fixation wants to avoid loading your model classes when the app initializes, not all features of regular ActiveRecord fixtures are supported:
+* the fixture filenames must match the database table names directly - whereas ActiveRecord actually assumes the filenames are underscored versions of the model class names, and it uses that class's configured table name
+* when using the identify syntax to set association foreign keys, you must use the name that corresponds to the foreign key attribute (for example, `parent: sue` if you want to set the `parent_id` field to the appropriate value for the fixture called `sue`) - whereas ActiveRecord accepts the name of the association (`lead_carer: sue`) even if it uses a different foreign key name (`belongs_to :lead_carer, :foreign_key => :parent_id`)
+* HABTM support has not been implemented (does anyone use HABTM these days?)
+* enums are not known
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/willbryant/fixation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fixation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixation.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fixation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fixation"
+  spec.version       = Fixation::VERSION
+  spec.authors       = ["Will Bryant"]
+  spec.email         = ["will.bryant@gmail.com"]
+
+  spec.summary       = %q{10x faster fixture startup under spring.}
+  spec.description   = %q{This gem will precompile the SQL statements needed to clear and repopulate your test tables with fixtures when the app boots under spring, so that spec startup just needs to run a small number of multi-row SQL statements to prepare for run.  This takes around 1/10th the time as a normal fixture load.}
+  spec.homepage      = "https://github.com/willbryant/fixation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fixation/version.rb

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

data/lib/fixation.rb

@@ -0,0 +1,262 @@
+require 'erb'
+require 'yaml'
+require 'set'
+require 'active_support/dependencies'
+require 'active_record/errors'
+require "fixation/version"
+
+module Fixation
+  class FixtureTable
+    attr_reader :filename, :table_name, :connection, :now
+
+    def initialize(filename, table_name, connection, now)
+      @filename = filename
+      @table_name = table_name
+      @connection = connection
+      @now = now
+    end
+
+    def columns_hash
+      @columns_hash ||= connection.columns(table_name).index_by(&:name)
+    end
+
+    def content
+      template = File.read(filename)
+      render_context = ActiveRecord::FixtureSet::RenderContext.create_subclass.new.get_binding
+      ERB.new(template).result(render_context)
+    end
+
+    def parsed_rows
+      result = YAML.load(content)
+      result ||= {} # for completely empty files
+
+      unless (result.is_a?(Hash) || result.is_a?(YAML::Omap)) && result.all? { |name, attributes| name.is_a?(String) && attributes.is_a?(Hash) }
+        raise ActiveRecord::Fixture::FormatError, "#{filename} needs to contain a hash of fixtures"
+      end
+
+      result.delete('DEFAULTS')
+      result
+    rescue ArgumentError, Psych::SyntaxError => error
+      # we use exactly the same error class and message as ActiveRecord::FixtureSet in case anyone was depending on it
+      raise ActiveRecord::Fixture::FormatError, "a YAML error occurred parsing #{filename}. Please note that YAML must be consistently indented using spaces. Tabs are not allowed. Please have a look at http://www.yaml.org/faq.html\nThe exact error was:\n  #{error.class}: #{error}", error.backtrace
+    end
+
+    def embellished_rows
+      @embellished_rows ||= parsed_rows.each do |name, attributes|
+        embellish_fixture(name, attributes, columns_hash)
+      end
+    end
+
+    def embellish_fixture(name, attributes, columns_hash)
+      # populate the primary key column, if not already set
+      if columns_hash['id'] && !attributes.has_key?('id')
+        attributes['id'] = Fixation.identify(name, columns_hash['id'].type)
+      end
+
+      if columns_hash['uuid'] && !attributes.has_key?('uuid')
+        attributes['uuid'] = Fixation.identify(name, columns_hash['uuid'].type)
+      end
+
+      # substitute $LABEL into all string values
+      attributes.each do |column_name, value|
+        attributes[column_name] = value.gsub("$LABEL", name) if value.is_a?(String)
+      end
+
+      # populate any timestamp columns, if not already set
+      %w(created_at updated_at).each do |column_name|
+        attributes[column_name] = now if columns_hash[column_name] && !attributes.has_key?(column_name)
+      end
+      %w(created_at updated_at).each do |column_name|
+        attributes[column_name] = now.to_date if columns_hash[column_name] && !attributes.has_key?(column_name)
+      end
+
+      # convert any association names into the identity column equivalent
+      nonexistant_columns = attributes.keys - columns_hash.keys
+      nonexistant_columns.each do |column_name|
+        if columns_hash["#{column_name}_id"]
+          value = attributes.delete(column_name)
+
+          if columns_hash["#{column_name}_type"] && value.is_a?(String) && value.sub!(/\s*\(([^\)]*)\)\s*$/, "")
+            # support polymorphic belongs_to as "label (Type)"
+            attributes["#{column_name}_type"] = $1
+          end
+
+          attributes["#{column_name}_id"] = value ? Fixation.identify(value) : value
+        else
+          raise ActiveRecord::Fixture::FormatError, "No column named #{column_name} found in table #{table_name}"
+        end
+      end
+    end
+
+    def fixture_ids
+      embellished_rows.each_with_object({}) do |(name, attributes), ids|
+        ids[name] = attributes['id'] || attributes['uuid']
+      end
+    end
+
+    def statements
+      statements = ["DELETE FROM #{connection.quote_table_name table_name}"]
+
+      unless embellished_rows.empty?
+        # first figure out what columns we have to insert into; we're going to need to use the same names for
+        # all rows so we can use the multi-line INSERT syntax
+        columns_to_include = Set.new
+        embellished_rows.each do |name, attributes|
+          attributes.each do |column_name, value|
+            columns_to_include.add(columns_hash[column_name])
+          end
+        end
+
+        # now build the INSERT statement
+        quoted_column_names = columns_to_include.collect { |column| connection.quote_column_name(column.name) }.join(', ')
+        statements <<
+          "INSERT INTO #{connection.quote_table_name table_name} (#{quoted_column_names}) VALUES " +
+          embellished_rows.collect do |name, attributes|
+            '(' + columns_to_include.collect do |column|
+              if attributes.has_key?(column.name)
+                quote_value(column, attributes[column.name])
+              else
+                column.default_function || quote_value(column, column.default)
+              end
+            end.join(', ') + ')'
+          end.join(', ')
+      end
+
+      statements
+    end
+
+    def quote_value(column, value)
+      connection.quote(value)
+    rescue TypeError
+      connection.quote(YAML.dump(value))
+    end
+  end
+
+  class Fixtures
+    def initialize
+      @class_names = {}
+      @fixture_ids = {}
+      @statements = {}
+
+      compile_fixture_files
+    end
+
+    def compile_fixture_files(connection = ActiveRecord::Base.connection)
+      puts "#{Time.now} building fixtures" if Fixation.trace
+
+      now = ActiveRecord::Base.default_timezone == :utc ? Time.now.utc : Time.now
+      Fixation.paths.each do |path|
+        Dir["#{path}/{**,*}/*.yml"].each do |pathname|
+          basename = pathname[path.size + 1..-5]
+          compile_fixture_file(pathname, basename.gsub('/', '_'), basename.classify, connection, now) if ::File.file?(pathname)
+        end
+      end
+
+      puts "#{Time.now} built fixtures for #{@fixture_ids} tables" if Fixation.trace
+    end
+
+    def compile_fixture_file(filename, table_name, class_name, connection, now)
+      fixture_table = FixtureTable.new(filename, table_name, connection, now)
+      @fixture_ids[table_name] = fixture_table.fixture_ids
+      @statements[table_name] = fixture_table.statements
+      @class_names[table_name] = class_name
+    end
+
+    def apply_fixtures(connection = ActiveRecord::Base.connection)
+      @statements.each do |table_name, table_statements|
+        table_statements.each do |statement|
+          connection.execute(statement)
+        end
+      end
+    end
+
+    def fixture_methods
+      fixture_ids = @fixture_ids
+      class_names = @class_names
+
+      methods = Module.new do
+        def setup_fixtures(config = ActiveRecord::Base)
+          if run_in_transaction?
+            @@fixated_fixtures_applied ||= false
+            unless @@fixated_fixtures_applied
+              puts "#{Time.now} applying fixtures" if Fixation.trace
+              Fixation.apply_fixtures
+              @@fixated_fixtures_applied = true
+              puts "#{Time.now} applied fixtures" if Fixation.trace
+            end
+          else
+            @@fixated_fixtures_applied = false
+          end
+          super
+        end
+
+        fixture_ids.each do |table_name, fixtures|
+          begin
+            klass = class_names[table_name].constantize
+          rescue NameError
+            next
+          end
+
+          accessor_name = table_name
+          define_method(accessor_name) do |*fixture_names|
+            force_reload = fixture_names.pop if fixture_names.last == true || fixture_names.last == :reload
+
+            @fixture_cache[table_name] ||= {}
+
+            instances = fixture_names.map do |name|
+              id = fixtures[name.to_s]
+              raise StandardError, "No fixture named '#{name}' found for fixture set '#{table_name}'" if id.nil?
+
+              @fixture_cache[table_name].delete(name) if force_reload
+              @fixture_cache[table_name][name] ||= klass.find(id)
+            end
+
+            instances.size == 1 ? instances.first : instances
+          end
+          private accessor_name
+        end
+      end
+    end
+  end
+
+  cattr_accessor :trace
+  cattr_accessor :paths
+  self.paths = %w(test/fixtures spec/fixtures)
+
+  def self.build_fixtures
+    subclasses_before = ActiveRecord::Base.subclasses
+
+    @fixtures = Fixtures.new
+
+    subclasses_after = ActiveRecord::Base.subclasses
+
+    unless subclasses_after.size == subclasses_before.size
+      new_subclasses = subclasses_after - subclasses_before
+      puts "warning: #{new_subclasses.to_sentence} #{new_subclasses.size == 1 ? 'was' : 'were'} auto-loaded while loading fixtures.  #{new_subclasses.size == 1 ? 'this class' : 'these classes'} may not reload properly."
+    end
+  end
+
+  def self.apply_fixtures
+    build_fixtures unless @fixtures
+    @fixtures.apply_fixtures
+  end
+
+  def self.fixture_methods
+    build_fixtures unless @fixtures
+    @fixtures.fixture_methods
+  end
+
+  # Returns a consistent, platform-independent identifier for +label+.
+  # Integer identifiers are values less than 2^30. UUIDs are RFC 4122 version 5 SHA-1 hashes.
+  #
+  # Uses the ActiveRecord fixtures method for compatibility.
+  if ActiveRecord::FixtureSet.method(:identify).arity == 1
+    def self.identify(label, _column_type = :integer)
+      ActiveRecord::FixtureSet.identify(label)
+    end
+  else
+    def self.identify(label, column_type = :integer)
+      ActiveRecord::FixtureSet.identify(label, column_type)
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: fixation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Will Bryant
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem will precompile the SQL statements needed to clear and repopulate
+  your test tables with fixtures when the app boots under spring, so that spec startup
+  just needs to run a small number of multi-row SQL statements to prepare for run.  This
+  takes around 1/10th the time as a normal fixture load.
+email:
+- will.bryant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixation.gemspec
+- lib/fixation.rb
+- lib/fixation/version.rb
+homepage: https://github.com/willbryant/fixation
+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.2.5
+signing_key: 
+specification_version: 4
+summary: 10x faster fixture startup under spring.
+test_files: []