composable_fixtures 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be1032be623a2fbb0a11d939764f6be915dc90bb
+  data.tar.gz: 2a7cab596fd2911f8465c2fc1e5d6ff5dcb4cae5
+SHA512:
+  metadata.gz: 508c0eb1a0ff441691deb96d6d3bb57d46baf7cfbe9a5401695ee190562169e8b20d2db09691078d956fbb2746757135aa90cbbfde662f82769d075144f8baa0
+  data.tar.gz: a73a64a659f0f89cfab02de0cb0b06e58e8fa1d48e99287195dd1fe676eb233052b2585577caf1895aa88d6091f4cc9c4513a50d24386648e977d3ffb8f7a2a4

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Optoro
+
+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,61 @@
+# composable_fixtures
+
+A [elight](http://github.com/elight) and [bhaibel](http://github.com/bhaibel) joint.
+
+## Installation
+
+NOTE: Currently depends on rspec and rspec-rails
+
+In your spec_helper, add the following:
+
+```ruby
+class RSpec::Core::ExampleGroup
+  extend ComposableFixtures::ExampleGroupHelpers
+end
+
+require 'rspec/rails'
+```
+
+You will also want ot add a FixtureSetDefinition. An example is given below.
+
+## Rough Example
+
+```ruby
+  FixtureSetDefinition.create do
+    set :normal_shipped,        "spec/auditor/fixtures/normal_shipped"
+    set :normal_shipped_amazon, "spec/auditor/fixtures/normal_shipped_amazon"
+	set :multiple               "spec/foo/fixtures", "spec/bar/fixtures"
+
+    compose :normal, :normal_shipped, :normal_shipped_amazon
+    compose :all_fixtures, :multiple, :normal
+  end
+
+  describe Foo do
+    # Any 'set' or 'compose' is a valid input and *only* loads those fixtures
+    use_composed_fixture_set :normal
+    fixtures :all
+  end
+```
+
+## Future direction
+
+We envision something ala a factories.rb file for the `FixtureSetDefinition` that, similar to factories.rb,
+could conceivably be defined over multiple files for sanity's sake.  Beyond that, the goal is to keep this gem relatively simple.
+
+We have a sister project under way internally for fixture generation from sanitized production/test data; however, it is not as yet ready for public release.
+
+## Contributing to composable_fixtures
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 Optoro. See LICENSE.txt for
+further details.
+

data/composable_fixtures.gemspec

@@ -0,0 +1,32 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: composable_fixtures 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "composable_fixtures"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Evan Light", "Betsy Haibel"]
+  s.date = "2015-01-30"
+  s.description = "Allows composing fixture sets"
+  s.email = "evan@tripledogdare.net"
+  s.files = %w[composable_fixtures.gemspec] + Dir['*.md', '*.txt', 'lib/**/*.rb']
+  s.homepage = "http://github.com/optoro/composable_fixtures"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Allows composing fixture sets"
+
+  s.add_development_dependency("rspec", "~> 3.1")
+  s.add_development_dependency("bundler", "~> 1.0")
+  s.add_development_dependency("simplecov", ">= 0")
+  s.add_development_dependency("rspec-rails", ">= 3")
+  s.add_development_dependency("pry", ">= 0.10")
+
+  s.add_runtime_dependency("rspec", "~> 3.1")
+  s.add_runtime_dependency("rspec-rails", ">= 3")
+end
+

data/lib/composable_fixtures/composable_fixture_set_definition.rb

@@ -0,0 +1,30 @@
+module ComposableFixtures
+  class ComposableFixtureSetDefinition
+    include Enumerable
+    
+    attr_reader :set_names
+    
+    def initialize(composition_name, set_names)
+      @name, @set_names = composition_name, set_names
+    end
+
+    def each(&block)
+      @set_names.each(&block)
+    end
+    
+    
+    def as_filename_to_yaml
+      set_names = @set_names.dup
+      set_name  = set_names.pop
+      set_def   = FixtureSetRepository.instance.fetch(set_name)
+      composer  = FixtureComposer.new(set_def.set_names)
+      
+      set_names.reduce(composer) do |acc_composer, set_name|
+        set_def = FixtureSetRepository.instance.fetch(set_name)        
+        composer.concat!(
+          FixtureComposer.new(set_def.set_names).as_filename_to_yaml
+        )
+      end.as_filename_to_yaml
+    end
+  end
+end

data/lib/composable_fixtures/fixture_composer.rb

@@ -0,0 +1,38 @@
+module ComposableFixtures
+  class FixtureComposer
+    def initialize(fixture_names)
+      @fixture_names = fixture_names
+      @filename_to_concatd_fixtures = {}
+    end
+
+    def as_filename_to_yaml
+      @fixture_names.each do |fixture_name|
+        set_def = FixtureSetRepository.instance.fetch(fixture_name)
+        set_def.each do |fixture_set_path|
+          Dir.foreach(fixture_set_path) do |filename|
+            next if filename =~ /^\./
+            extract_fixture_from(fixture_set_path, filename)
+          end
+        end
+      end
+      @filename_to_concatd_fixtures
+    end
+
+    def extract_fixture_from(fixture_set_path, filename)
+      File.open(File.join(fixture_set_path, filename), "r") do |f|
+        contents = f.readlines
+        
+        if @filename_to_concatd_fixtures.has_key?(filename)
+          # Remove "---" at top of YAML
+          contents.shift
+        else
+          # We haven't loaded any of this file yet so initialize it with a string
+          @filename_to_concatd_fixtures[filename] = ""
+        end
+        
+        @filename_to_concatd_fixtures[filename] += contents.join("\n")
+      end
+    end
+  end
+end
+

data/lib/composable_fixtures/fixture_directory.rb

@@ -0,0 +1,49 @@
+require 'tmpdir'
+require 'singleton'
+
+module ComposableFixtures
+  class FixtureDirectory
+    include Singleton
+
+    class DirectoryAlreadyExistsError < StandardError; end
+    class DirectoryDoesntExistError   < StandardError; end
+
+    def create
+      raise DirectoryAlreadyExistsError if @dir
+      @dir = Dir.mktmpdir
+    end
+
+    def destroy
+      raise DirectoryDoesntExistError unless @dir
+      FileUtils.remove_entry @dir
+    end
+
+    def write(name_to_fixtures)
+      name_to_fixtures.each do |(name, yaml)|
+        File.open(File.join(path, name), "w") do |f|
+          f.write yaml
+        end
+      end      
+    end
+
+    def path
+      @dir.to_s
+    end
+
+    def self.create
+      instance.create
+    end
+
+    def self.write(fixtures)
+      instance.write(fixtures)
+    end
+
+    def self.destroy
+      instance.destroy
+    end
+
+    def self.path
+      instance.path
+    end
+  end
+end

data/lib/composable_fixtures/fixture_set_definition.rb

@@ -0,0 +1,21 @@
+module ComposableFixtures
+  class FixtureSetDefinition
+    attr_reader :name, :paths
+    
+    def self.create(name, paths)
+      FixtureSetRepository.instance.register(
+        name,
+        new(name, paths)
+      )
+    end
+
+    def each(&block)
+      @paths.each(&block)
+    end
+
+    def initialize(name, paths)
+      @name, @paths = name, paths
+    end
+  end  
+end
+

data/lib/composable_fixtures/fixture_set_repository.rb

@@ -0,0 +1,26 @@
+require 'singleton'
+
+module ComposableFixtures
+  class FixtureSetRepository
+    include Singleton
+    include Enumerable
+
+    def register(name, set_definition)
+      repository[name] = set_definition
+    end
+
+    def fetch(name)
+      repository.fetch(name)
+    end
+
+    def each(&block)
+      repository.values.each(&block)
+    end
+    
+    private
+    
+    def repository
+      @repository ||= {}
+    end
+  end  
+end

data/lib/composable_fixtures/rspec_integration.rb

@@ -0,0 +1,3 @@
+class RSpec::Core::ExampleGroup
+  extend ComposableFixtures::ExampleGroupHelpers
+end

data/lib/composable_fixtures/rspec_rails_integration.rb

@@ -0,0 +1,22 @@
+if defined?(Rails)
+  require 'rspec/rails'
+else
+  # FIXME: This breaks when you go to access a fixture by name because the
+  # fixture_cache is nil
+  module Rails
+    module VERSION
+      STRING = "3.2.17"
+    end
+  end
+  
+  require 'rspec/rails/adapters'
+  require 'rspec/rails/fixture_support'
+
+  RSpec.configure do |c|
+    c.include RSpec::Rails::FixtureSupport
+    c.add_setting :fixture_path  
+    c.add_setting :use_transactional_fixtures, :alias_with => :use_transactional_examples
+    c.add_setting :use_instantiated_fixtures
+    c.add_setting :global_fixtures
+  end
+end

data/lib/composable_fixtures.rb

@@ -0,0 +1,37 @@
+require 'composable_fixtures/fixture_set_definition'
+require 'composable_fixtures/fixture_set_repository'
+require 'composable_fixtures/fixture_directory'
+require 'composable_fixtures/fixture_composer'
+
+module ComposableFixtures
+  module ExampleGroupHelpers
+    def use_composed_fixture_set(*fixtures)
+      FixtureDirectory.create
+      FixtureDirectory.write(
+        FixtureComposer.new(fixtures).as_filename_to_yaml
+      )
+      
+      self.fixture_path = FixtureDirectory.path
+
+      after(:all) do
+        FixtureDirectory.destroy
+      end
+    end
+  end
+
+  def self.define(&block)
+    module_eval(&block)
+  end
+
+  def self.set(name, *fixture_set_paths)
+    FixtureSetDefinition.create(name, fixture_set_paths)
+  end
+
+  def self.compose(name, *set_names)
+    fixture_set_paths =
+      set_names.reduce([]) do |fixture_set_paths, set_name|
+        fixture_set_paths += FixtureSetRepository.instance.fetch(set_name).paths
+      end
+    set(name, *fixture_set_paths)
+  end
+end

data/lib/fixture_directory.rb

@@ -0,0 +1,46 @@
+require 'tmpdir'
+require 'singleton'
+
+module ComposableFixtures
+  class FixtureDirectory
+    include Singleton
+
+    class DirectoryAlreadyExistsError < StandardError; end
+    class DirectoryDoesntExistError   < StandardError; end
+
+    def create
+      raise DirectoryAlreadyExistsError if @dir
+      @dir = Dir.mktmpdir
+    end
+
+    def destroy
+      raise DirectoryDoesntExistError unless @dir
+      FileUtils.remove_entry @dir
+    end
+
+    def write
+      name_to_fixtures.each do |(name, yaml)|
+        File.open(File.join(path, name), "w") do |f|
+          f.write yaml
+        end
+      end      
+    end
+
+    def path
+      @dir.to_s
+    end
+    
+
+    def self.create
+      instance.create
+    end
+
+    def self.write(fixtures)
+      instance.write(fixtures)
+    end
+
+    def self.destroy
+      instance.destroy
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: composable_fixtures
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Light
+- Betsy Haibel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Allows composing fixture sets
+email: evan@tripledogdare.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- composable_fixtures.gemspec
+- README.md
+- LICENSE.txt
+- lib/composable_fixtures/composable_fixture_set_definition.rb
+- lib/composable_fixtures/fixture_composer.rb
+- lib/composable_fixtures/fixture_directory.rb
+- lib/composable_fixtures/fixture_set_definition.rb
+- lib/composable_fixtures/fixture_set_repository.rb
+- lib/composable_fixtures/rspec_integration.rb
+- lib/composable_fixtures/rspec_rails_integration.rb
+- lib/composable_fixtures.rb
+- lib/fixture_directory.rb
+homepage: http://github.com/optoro/composable_fixtures
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Allows composing fixture sets
+test_files: []
+has_rdoc: