fixture_overlord 0.1.8

data/lib/fixture_overlord/helpers.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+require 'ostruct'
+require 'securerandom'
+
+# TODO: refactor to a class
+module FixtureOverlord
+  module Helpers
+    extend self
+
+    # reading the yaml filename
+    def yaml_filename(file)
+      ::File.basename(file).split('.').first
+    end
+
+    # take the yaml filename and convert it to a model classname
+    def to_model(file)
+      model = yaml_filename(file).to_s.classify.constantize
+      model
+    end
+
+    # check to see if the model is inherited from ActiveRecord
+    #
+    # TODO: Add more than just ActiveRecord, specifically Sequel
+    #
+    def persisted_model?(file)
+      model = to_model(file)
+      model.respond_to?(:superclass) && model.superclass == ::ActiveRecord::Base
+    end
+
+    def respond_to_model_methods?(model)
+      model.respond_to?(:create!) || model.respond_to?(:create) || model.respond_to?(:build)
+    end
+
+  end
+end

data/lib/fixture_overlord/mock.rb

@@ -0,0 +1,132 @@
+require 'ostruct'
+require 'securerandom'
+require_relative 'helpers'
+require_relative 'hashish'
+
+module FixtureOverlord
+  class Mock < OpenStruct
+
+    def self.setup(hash)
+      new(hash)
+    end
+
+    def initialize(hash)
+      super(hash.merge(generate_id))
+    end
+
+    # Converts attributes back to a hash (Hashish).
+    # Beacuse this is still a Hashish Hash, we can covert
+    # it back to a mock.
+    #
+    # ==== Examples
+    #
+    # e.g.
+    #   blog.to_attributes => { title: 'Blog' }
+    #
+    def to_attributes
+      Hashish[self.to_h].symbolize_keys
+    end
+
+
+    # add a child association
+    #
+    # ==== Examples
+    #
+    # e.g. (has_many)
+    #
+    #   blog.child(posts: post)
+    #   blog.posts.first.title
+    #
+    # There are 4 methods aliased to this one to provide
+    # the developer ActiveRecord & a Sequel (ORM) like
+    # interface.
+    #
+    def child(options)
+      associations(options) do |k,v|
+        writer(k,[v])
+      end
+    end
+    alias :has_many     :child
+    alias :one_to_many  :child
+
+
+    # add a parent association
+    #
+    # ==== Examples
+    #
+    # e.g. (belongs_to)
+    #
+    #   post.parent(blog: blog)
+    #   post.blog.name
+    #
+    # There are 4 methods aliased to this one to provide
+    # the developer ActiveRecord & a Sequel (ORM) like
+    # interface.
+    #
+    def parent(options)
+      associations(options) do |k,v|
+        writer(k,v)
+      end
+    end
+    alias :belongs_to   :parent
+    alias :many_to_one  :parent
+    alias :has_one      :parent
+    alias :one_to_one   :parent
+
+
+    # change a key/value or add one
+    #
+    # ==== Examples
+    #
+    # e.g.
+    #   games(:donkey_kong).change(name: 'Jumpman Jr.').mock
+    #   games(:donkey_kong).add(leader: 'Jacob').mock
+    #
+    def change(options = {})
+      options.each { |k,v| writer(k,v) }
+      self
+    end
+    alias :add :change
+
+
+    # remove an attribute from the class
+    #
+    # ==== Examples
+    #
+    # e.g.
+    #   blog.remove(:name)
+    #   blog.name == nil
+    #
+    def remove(key)
+      writer(key)
+    end
+    alias :delete :remove
+
+
+    private
+
+    # generate a unique id and return the hash
+    #
+    def generate_id
+      { id: ::SecureRandom.random_number(99999) }
+    end
+
+    # assign a value to a hash key
+    #
+    def writer(key, value = nil)
+      self.send("#{key}=", value)
+    end
+
+    def build_model_base
+      @build_model_base ||= Helpers.to_model(yaml_filename)
+    end
+
+    def associations(options, &block)
+      options.each do |k,v|
+        v = Mock.setup(v) if v.is_a?(Hash) || v.is_a?(Hashish)
+        yield k, v
+      end
+    end
+
+  end
+end

data/lib/fixture_overlord/model.rb

@@ -0,0 +1,55 @@
+require 'active_support/core_ext/string/inflections.rb'
+
+module FixtureOverlord
+  class Model
+
+    class << self
+      def init(hash, filename)
+        new(hash, filename).new_model_with_values
+      end
+
+      def create(hash, filename)
+        new(hash, filename).create_as_model
+      end
+      alias_method :create!, :create
+    end
+
+    def initialize(hash, filename)
+      @hash, @filename = hash, filename
+    end
+
+    def convert_to_model
+      model_name.new( sanitize_hash )
+    end
+
+    def new_model_with_values
+      model_name.new( sanitize_hash )
+    end
+
+    def create_as_model
+      model_name.create( sanitize_hash )
+    end
+
+    def model_name
+      @model_name ||= @filename.to_s.singularize.classify.constantize
+    end
+
+    def can_convert_to_model?
+      model = model_name
+      model.respond_to?(:superclass) &&
+        model.superclass == ::ActiveRecord::Base
+    end
+
+    def respond_to_model_methods?
+      model = convert_to_model
+      model.respond_to?(:create!) ||
+        model.respond_to?(:create) ||
+        model.respond_to?(:build)
+    end
+
+    def sanitize_hash
+      @hash.delete_if { |key,value| key.to_sym == :id }
+    end
+
+  end
+end

data/lib/fixture_overlord/object_coercion.rb

@@ -0,0 +1,7 @@
+
+module FixtureOverlord
+  class ObjectCoercion
+    def initialize
+    end
+  end
+end

data/lib/fixture_overlord/read_fixture.rb

@@ -0,0 +1,62 @@
+require_relative 'hashish'
+require 'yaml'
+require 'erb'
+
+module FixtureOverlord
+  FormattingError = Class.new(StandardError)
+
+  def self.read_fixture(yaml_file, key)
+    ReadFixture.new(yaml_file).read(key)
+  end
+
+  class ReadFixture
+    def initialize(file)
+      @file = file
+    end
+
+    def read(key = nil)
+      hash = read_file
+      hash = hash[key.to_s] unless key.nil?
+      Hashish[hash].symbolize_keys
+    end
+
+    private
+
+    # CREDIT: The next three methods are almost identitical to those within Rails' 
+    #         ActiveRecord FixtureSet::File
+    #
+    # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/fixture_set/file.rb
+    #
+    def read_file
+      begin
+        data = ::YAML.load(render)
+      rescue ::ArgumentError, ::Psych::SyntaxError => error
+        raise FormattingError, "a YAML error ocurred parsing #{@file}.\nThe error was:\n #{error.class}: #{error}", error.backtrace
+      end
+      validate(data)
+    end
+
+    def validate(data)
+      unless valid_data?(data)
+        raise FormattingError, "fixture is not a Hash or YAML::Omap."
+      end
+
+      raise FormattingError unless data.all? { |name, row| ::Hash === row }
+      data
+    end
+
+    def render
+      erb_render(
+        IO.read(@file)
+      )
+    end
+
+    def erb_render(content)
+      ::ERB.new(content).result
+    end
+
+    def valid_data?(data)
+      ::Hash === data || ::YAML::Omap === data
+    end
+  end
+end

data/lib/fixture_overlord/string_extension.rb

@@ -0,0 +1,29 @@
+
+class String
+  def classify
+    if defined?(ActiveSupport::Inflector)
+      ActiveSupport::Inflector.classify(self)
+    else
+      self.gsub(/(_|-)/, ' ').
+        split(' ').each do |word|
+        word.capitalize!
+      end.join
+    end
+  end
+
+  def constantize
+    if defined?(ActiveSupport::Inflector)
+      ActiveSupport::Inflector.constantize(self)
+    else
+      Object.const_get(self)
+    end
+  end
+
+  def singularize
+    if defined?(ActiveSupport::Inflector)
+      ActiveSupport::Inflector.singularize(self, :en)
+    else
+      self
+    end
+  end
+end

data/lib/fixture_overlord/version.rb

@@ -0,0 +1,10 @@
+
+module FixtureOverlord
+  def self.version
+    [MAJOR, MINOR, PATCH].join('.')
+  end
+
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 8
+end

data/lib/fixture_overlord.rb

@@ -0,0 +1,17 @@
+require 'ostruct'
+require 'yaml'
+require 'securerandom'
+require 'erb'
+
+require_relative "fixture_overlord/string_extension" unless defined?(ActiveSupport::Inflector)
+require_relative 'fixture_overlord/fixture_accessor'
+
+module FixtureOverlord
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    include FixtureAccessor
+  end
+end

data/test/fixture_accessor_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+require './lib/fixture_overlord'
+
+class Minitest::Test
+  include ::FixtureOverlord
+  fixture_overlord :rule
+end
+
+module FixtureOverlord
+  class FixtureAccessorTest < Minitest::Test
+
+    def hash
+      @hash ||= { name: 'Bob', age: 44 }
+    end
+
+    def bob
+      @bob ||= person(:bob).mock
+    end
+
+    def test_hash_fixture
+      assert_equal hash, person(:bob)
+    end
+
+    def test_mock_fixture
+      assert bob
+      assert bob.id
+      assert_equal 'Bob', bob.name
+      assert_equal 44,    bob.age
+
+      assert_equal hash.merge(id: bob.id), bob.to_attributes
+    end
+
+    def test_mock_association
+      mobile = phone(:bob_mobile).mock
+      shared_mock_association_tests(bob, mobile)
+    end
+
+    def test_mock_assocation_when_assocation_is_hash
+      mobile = phone(:bob_mobile)
+      shared_mock_association_tests(bob, mobile)
+    end
+
+    def test_mock_association_belongs_to
+      cw = company(:cw).mock
+      assert cw.id
+      assert cw.name
+      assert cw.description
+
+      assert bob.belongs_to(company: cw)
+      assert_equal "Code Wranglers", bob.company.name
+      assert_equal "Custom Software Development", bob.company.description
+    end
+
+    def test_mock_association_belongs_to_when_association_is_hash
+      cw = company(:cw)
+
+      assert bob.belongs_to(company: cw)
+      assert_equal "Code Wranglers", bob.company.name
+      assert_equal "Custom Software Development", bob.company.description
+    end
+
+    def test_changing_a_mock_attribute
+      cw = company(:cw).mock
+      cw.change(name: 'Code Wranglers, Inc.')
+      assert_equal "Code Wranglers, Inc.", cw.name
+
+      cw.change(name: 'Code Wranglers - Software Development')
+      assert_equal 'Code Wranglers - Software Development', cw.name
+    end
+
+    def test_adding_a_new_attribute
+      bob.add(gender: 'male')
+      assert_equal 'male', bob.gender
+
+      bob.change(gender: 'unicorn')
+      assert_equal 'unicorn', bob.gender
+    end
+
+    def test_removing_attributes
+      bob.remove(:name)
+      assert_nil bob.name
+    end
+
+    private
+
+    def shared_mock_association_tests(object, assoc)
+      assert object.has_many(phones: assoc)
+
+      assert_equal 18001234567, object.phones.first.number
+      assert_equal 1,           object.phones.size
+      assert_equal "cell",      object.phones.first.type
+
+      assert object.phones.first.id
+    end
+
+  end
+end