traitr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a70000928ed720a84d8e3917407c987746e00b2
+  data.tar.gz: eaa7da7e08396b1943446e3fc3ad3e9e319cb6cc
+SHA512:
+  metadata.gz: 49ff026c248777c002fb8f743c54eff1fc4e4f56d3984599a712d60cb35c60836137a1fc3ac555ed60379f926c643983fb3236a504ab88b3437d957a9453d648
+  data.tar.gz: 1f258d37b1e7be543bf8b0aa0bb44348664737b3b654bfa46405ddb87cf2c0689f84ecdd0964872a80eae67012c9111c2f12c0c548622c3d30ffe45e56853d88

data/lib/traitor/config.rb

@@ -0,0 +1,15 @@
+module Traitor
+  class Config
+    def self.configure_for_rails!
+      Traitor.instance_variable_set(:@save_method, :save)
+      Traitor.instance_variable_set(:@save_kwargs, {validate: false})
+      Traitor.instance_variable_set(:@build_kwargs, {without_protection: true})
+    end
+
+    def self.configure_safe_for_rails!
+      Traitor.instance_variable_set(:@save_method, :save)
+      Traitor.instance_variable_set(:@save_kwargs, {})
+      Traitor.instance_variable_set(:@build_kwargs, {})
+    end
+  end
+end

data/lib/traitor/error.rb

@@ -0,0 +1,3 @@
+module Traitor
+  class Error < StandardError; end
+end

data/lib/traitor/find_definitions.rb

@@ -0,0 +1,28 @@
+# based on https://github.com/thoughtbot/factory_girl/blob/master/lib/factory_girl/find_definitions.rb
+# as of 2016-07-21
+# Copyright (c) 2008-2016 Joe Ferris and thoughtbot, inc. MIT License
+module Traitor
+  class << self
+    # An Array of strings specifying locations that should be searched for
+    # factory definitions. By default, traitor will attempt to require
+    # "traitors", "test/traitors" and "spec/traitors". Only the first
+    # existing file will be loaded.
+    attr_accessor :definition_file_paths
+  end
+
+  self.definition_file_paths = %w(traitors test/traitors spec/traitors)
+
+  def self.find_definitions
+    absolute_definition_file_paths = definition_file_paths.map { |path| File.expand_path(path) }
+
+    absolute_definition_file_paths.uniq.each do |path|
+      load("#{path}.rb") if File.exist?("#{path}.rb")
+
+      if File.directory? path
+        Dir[File.join(path, '**', '*.rb')].sort.each do |file|
+          load file
+        end
+      end
+    end
+  end
+end

data/lib/traitor.rb

@@ -0,0 +1,103 @@
+require 'traitor/config'
+require 'traitor/find_definitions'
+require 'traitor/error'
+
+module Traitor
+  @trait_library = {}
+  @block_library = {}
+
+  @save_method = nil
+  @save_kwargs = {}
+  @build_kwargs = {}
+
+  @class_cache = {}
+  @trait_cache = {}
+
+  class << self
+    attr_writer :save_method, :save_kwargs, :build_kwargs
+  end
+
+  def self.reset!
+    @trait_library = {}
+    @class_cache = {}
+    @trait_cache = {}
+  end
+
+  def self.define(klass, **traits, &block)
+    if @trait_library.include? klass
+      @trait_library[klass].merge!(traits)
+    else
+      @trait_library[klass] = traits
+    end
+    @block_library[klass] = block if block_given?
+  end
+
+  ##
+  # build an instance of an object using the defined traits and attributes,
+  # and then save it.
+  ##
+  def self.create(klass, *traits, **attributes, &block)
+    raise Traitor::Error.new("Cannot call Traitor.create until you have configured Traitor.save_method!") unless @save_method
+    record = build(klass, *traits, **attributes, &block)
+    record.public_send(@save_method, **@save_kwargs)
+    yield(record, at: :create) if block_given?
+    run_class_block(klass, record, :build)
+    record
+  end
+
+  ##
+  # build an instance of an object using the defined traits and attributes.
+  ##
+  def self.build(klass, *traits, **attributes, &block)
+    attributes = get_attributes_from_traits(klass, traits).merge(attributes)
+    record = convert_to_class(klass).new(attributes, **@build_kwargs)
+    yield(record, at: :build) if block_given?
+    run_class_block(klass, record, :build)
+    record
+  end
+
+  # private methods
+
+  def self.run_class_block(klass, record, at)
+    class_block = @block_library[klass]
+    class_block.call(record, at: at) if class_block
+  end
+  private_class_method :run_class_block
+
+  def self.convert_to_class(klass)
+    @class_cache[klass] ||= Object.const_get(camelize(klass))
+  rescue NameError
+    raise Traitor::Error.new("Tried to create a #{camelize(klass)}, but it does not exist!")
+  end
+  private_class_method :convert_to_class
+
+  def self.get_attributes_from_traits(klass, traits)
+    # we only call this method when the klass has been converted to a key inside create
+    return {} unless library = @trait_library[klass]
+
+    traits = [:default_traits] + traits # always include default_traits as the first thing
+
+    cache_key = klass.to_s + ':' + traits.join(':')
+    @trait_cache[cache_key] ||= {}.tap do |attributes|
+      traits.each { |trait| attributes.merge!(library[trait] || {}) }
+    end
+
+    # use late resolution on lambda values by calling them here as part of constructing a new hash
+    Hash[
+      @trait_cache[cache_key].map do |attribute, value|
+        [attribute, value.is_a?(Proc) ? value.call : value]
+      end
+    ]
+  end
+  private_class_method :get_attributes_from_traits
+
+  # simplified from Rails.
+  def self.camelize(term)
+    string = term.to_s
+    string = string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+    string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+    string.gsub!('/'.freeze, '::'.freeze)
+    string
+  end
+  private_class_method :camelize
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: traitr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zach Lome
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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-its
+  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: timecop
+  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: pry
+  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: a lightweight, simplified, pure-ruby way to handle object model construction,
+  similar to FactoryGirl.
+email:
+- zslome@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/traitor.rb
+- lib/traitor/config.rb
+- lib/traitor/error.rb
+- lib/traitor/find_definitions.rb
+homepage: https://github.com/kuraiou/traitor
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: a lightweight way to bind groups of attributes to a trait.
+test_files: []
+has_rdoc: