fixturator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d13b00b65c1bbc1aeffdf694c39ea127e77ea6a0
+  data.tar.gz: 7969f24d2dcb767b5facf64c92520a77c0492b78
+SHA512:
+  metadata.gz: 30a997bfc14ddf4b830109f9438b93d59bcd09f7b92b3a53081439e209f1c069161be669986e549e3171b7f08511c3fb3efec77ad352d4880bd627ffb31e9e43
+  data.tar.gz: e13e559f29ee1544fe27c9af0513d9832269b06a847d02399832a2a0f53bfa239b9dbb10b065375e4eb09a6820fec77f6c4d1da89f9354ce31e0bac6c56baf02

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Bernardo Farah
+
+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,87 @@
+# Fixturator
+
+Fixturator is a Rails plugin that generates fixtures from your ActiveRecord
+models. It requires you to whitelist models in your `config/fixturator.yml`
+
+**QUIRKS**
+
+I've made `created_at` and `updated_at` always output the same time. The reason
+this is part of the gem is that git diffs get really messy otherwise.
+
+You can also exclude timestamps entirely by using the `exclude_timestamps`
+setting
+
+## Usage
+
+There are two ways to use Fixturator. There's a rake task that it comes with,
+but you can also call it yourself with a model.
+
+#### Rake task
+
+This gem ships with a rake task that can read a file located at
+`config/fixturator.yml`
+
+```sh
+bin/rake db:fixtures:generate
+```
+
+Here's an example configuration with all valid attributes:
+
+```yml
+# Excludes created_at and updated_at on all models
+exclude_timestamps: false
+
+# The models for which fixtures are generated
+models:
+  - name: Driver
+  - name: User
+    # excluded attributes for that model
+    exclude:
+      - secret_attribute
+      - ssn
+```
+
+
+#### Ruby interface
+
+```rb
+Fixturator.generate!
+# Uses the config/fixturator.yml
+# generates a bunch of fixtures in your configured fixture directory
+
+Fixturator.call(User, exclude_attributes: ["created_at"])
+# generates a User fixture at your configured fixture directory
+# by default it's at test/fixtures/users.yml
+```
+
+#### Locating all existing models
+
+If you want to create fixtures for all of your models, you can check out [this
+issue](https://github.com/coverhound/fixturator/issues/8) on more details of how
+to get a complete list. You can use a locator in conjunction with
+`Fixturator.call(model)` to do so.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixturator'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install fixturator
+```
+
+## Contributing
+Please submit specific issue reports if you see this working in a way you
+wouldn't expect. PRs and discussion is welcomed and appreciated!
+
+## 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,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Fixturator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/fixturator/configuration.rb

@@ -0,0 +1,41 @@
+require "yaml"
+require "fixturator/model"
+
+module Fixturator
+  class Configuration
+    class << self
+      def load
+        hash = YAML.safe_load(config_file)
+        hash ? new(**hash.symbolize_keys!) : new
+      end
+
+      private
+
+      def config_file
+        return "" unless File.exist?(config_path)
+        File.read(config_path)
+      end
+
+      def config_path
+        Rails.root.join("config", "fixturator.yml")
+      end
+    end
+
+    def initialize(models: [], exclude_timestamps: false)
+      @models = models.map(&Model.method(:new)).compact
+      exclude_timestamps_from(@models) if exclude_timestamps
+    end
+
+    attr_reader :models
+
+    private
+
+    def exclude_timestamps_from(models)
+      models.each { |model| model.excluded_attributes.concat(timestamps) }
+    end
+
+    def timestamps
+      %w(created_at updated_at)
+    end
+  end
+end

data/lib/fixturator/generator.rb

@@ -0,0 +1,69 @@
+require "yaml"
+
+module Fixturator
+  class Generator
+    def initialize(model, excluded_attributes: [])
+      @model = model
+      @excluded_attributes = excluded_attributes
+    end
+
+    def call
+      with_fixture_file do |file|
+        model.find_each.with_index do |record, index|
+          file.puts(fixturize(record, index + 1))
+        end
+      end
+    end
+
+    private
+
+    attr_reader :model, :excluded_attributes
+
+    def with_fixture_file(&block)
+      File.open(fixture_path, "w", &block)
+    end
+
+    def fixturize(record, index)
+      to_yaml(
+        "#{model_lower_name}_#{index}" => attributes_for(record)
+      )
+    end
+
+    def to_yaml(hash)
+      remove_yaml_header(hash.to_yaml) + "\n"
+    end
+
+    def remove_yaml_header(yaml)
+      yaml.sub(/\A---\n/, "")
+    end
+
+    def attributes_for(record)
+      record.
+        attributes.
+        compact.
+        tap(&method(:replace_times)).
+        except(*excluded_attributes)
+    end
+
+    def replace_times(attributes)
+      attributes["created_at"] = static_time if attributes["created_at"]
+      attributes["updated_at"] = static_time if attributes["updated_at"]
+    end
+
+    def static_time
+      Time.parse("2016-10-10").utc
+    end
+
+    def fixture_path
+      if Rails::VERSION::MAJOR > 5
+        ActiveSupport::TestCase.fixture_path
+      else
+        Rails.root.join("test", "fixtures", model_lower_name.pluralize + ".yml")
+      end
+    end
+
+    def model_lower_name
+      model.name.underscore.gsub("/", "_")
+    end
+  end
+end

data/lib/fixturator/model.rb

@@ -0,0 +1,32 @@
+require "fixturator/generator"
+
+module Fixturator
+  class Model
+    class << self
+      def new(hash)
+        name = to_model(hash["name"]) or return nil
+
+        hash["name"] = name
+        super(hash)
+      end
+
+      private
+
+      def to_model(name)
+        name = name.safe_constantize or return nil
+        name.ancestors.include?(ActiveRecord::Base) ? name : nil
+      end
+    end
+
+    def initialize(hash)
+      @name = hash.fetch("name")
+      @excluded_attributes = hash.fetch("exclude", [])
+    end
+
+    attr_reader :name, :excluded_attributes
+
+    def to_fixture
+      Generator.new(name, excluded_attributes: excluded_attributes).call
+    end
+  end
+end

data/lib/fixturator/railtie.rb

@@ -0,0 +1,7 @@
+module Fixturator
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/fixtures_generate.rake"
+    end
+  end
+end

data/lib/fixturator/version.rb

@@ -0,0 +1,3 @@
+module Fixturator
+  VERSION = '1.0.0'
+end

data/lib/fixturator.rb

@@ -0,0 +1,25 @@
+require "fixturator/railtie"
+require "fixturator/configuration"
+require "fixturator/generator"
+
+module Fixturator
+  class << self
+    def generate!
+      config = Configuration.load
+      yield config if block_given?
+
+      config.models.each do |model|
+        puts "Generating fixtures for #{model.name}..."
+        model.to_fixture
+      end
+    end
+
+    def call(*args)
+      Generator.new(*args).call
+    end
+
+    def to_proc
+      method(:call)
+    end
+  end
+end

data/lib/tasks/fixtures_generate.rake

@@ -0,0 +1,11 @@
+require 'fixturator'
+
+namespace :db do
+  namespace :fixtures do
+
+    desc "Generate fixtures based off of active_record models."
+    task generate: :environment do
+      Fixturator.generate!
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: fixturator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bernardo Farah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: Fixturator is a fixture generator for ActiveRecord models
+email:
+- bernardo@coverhound.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/fixturator.rb
+- lib/fixturator/configuration.rb
+- lib/fixturator/generator.rb
+- lib/fixturator/model.rb
+- lib/fixturator/railtie.rb
+- lib/fixturator/version.rb
+- lib/tasks/fixtures_generate.rake
+homepage: https://github.com/coverhound/fixturator
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Fixturator is a fixture generator for ActiveRecord models
+test_files: []