industrialist 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858f0f4e068299c8eab65bf53cc4b78b5d582ad1a36a81bd85c41654c21e9855
-  data.tar.gz: ed03501fc2ab8f74f5ac29d1e47675ac77977e5c859a5a9ddd9701b28afdbc70
+  metadata.gz: 7bf85f2b3f9c6e8cc3544f300a89d48a9c2f14474346b3241724cb332b10eaad
+  data.tar.gz: 6b94cbc0377996523a94f3a1a43c47b0cd04f80ddee3dba44ef4714a44e58dac
 SHA512:
-  metadata.gz: 751a1bbef0a2f80b1936d0b23608880fd5a3cec7a4dcdeea0d8f705c96a4c86d37c5576364cf484159054be6845deadb3bb038fb298daa959d96fe7add723877
-  data.tar.gz: 8ec6e11e6851d7f17a0f7e92e3ebb6e246daab3b747534cf365ea623a1d4ff3390a202cdb92d7e815320b3062439fe82a0981a06837e19c0f93d98822f35e170
+  metadata.gz: 4dc4590b03d9f2937814364ed9821f9eba370795e23733a4f8220d62763aed772083fd22761cbba1870d054c77a46faf3288b0603eb81aa44cf1949d55568737
+  data.tar.gz: d9f688cc1227649418fa59d4e0dc029dff07cf04db933199a40013a907f46b6fcda2de1c9be684332587889baf76915ba8e71e76cf49fa8a7aa8169e91310efc

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    industrialist (0.4.0)
+    industrialist (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -76,12 +76,11 @@ You can find a deeper dive into the motivations behind Industrialst [here](https
 
 ## Usage
 
-Industrialist creates factories for you. Just include the Manufacturable module in a base class and call `create_factory` with a name. Industrialist also allows children of the base class to register themselves with the factory by specifying their corresponding key.
+Industrialist creates factories for you. Just extend the Manufacturable module in a base class. This will register a manufacturable type based on the class name. Children of the base class can register themselves with the factory by specifying their corresponding key. To build an instance specify the manufacturable type and key.
 
 ```ruby
 class Automobile
-  include Industrialist::Manufacturable
-  create_factory :AutomobileFactory
+  extend Industrialist::Manufacturable
 end
 
 class Sedan < Automobile
@@ -92,7 +91,7 @@ class Coupe < Automobile
   corresponds_to :coupe
 end
 
-AutomobileFactory.build(:sedan)  # => #<Sedan:0x00007ff64d88ce58>
+Industrialist.build(:automobile, :sedan)  # => #<Sedan:0x00007ff64d88ce58>
 ```
 
 Manufacturable classes may also correspond to multiple keys:
@@ -107,29 +106,27 @@ end
 By default, Industrialist factories will return `nil` when built with an unregistered key. If you would instead prefer a default object, you can designate a `manufacturable_default`.
 
 ```ruby
-class Airplane
-  include Industrialist::Manufacturable
-  create_factory :AirplaneFactory
+class Plane
+  extend Industrialist::Manufacturable
 end
 
-class Biplane < Airplane
+class Biplane < Plane
   manufacturable_default
   corresponds_to :biplane
 end
 
-class FighterJet < Airplane
+class FighterJet < Plane
   corresponds_to :fighter
 end
 
-AirplaneFactory.build(:plane)  # => #<Biplane:0x00007ffcd4165610>
+Industrialist.build(:plane, :bomber)  # => #<Biplane:0x00007ffcd4165610>
 ```
 
-Finally, Industrialist will accept any Ruby object as a key, which is handy when you need to define more complex keys. For example, you could use a hash:
+Industrialist can accept any Ruby object as a key, which is handy when you need to define more complex keys. For example, you could use a hash:
 
 ```ruby
 class Train
-  include Industrialist::Manufacturable
-  create_factory :TrainFactory
+  extend Industrialist::Manufacturable
 end
 
 class SteamEngine < Train
@@ -153,12 +150,24 @@ class Sleeper < Train
 end
 
 def train_car(role, type)
-  TrainFactory.build(role => type)
+  Industrialist.build(:train, role => type)
 end
 
 train_car(:engine, :diesel)  # => #<Diesel:0x00007ff64f846640>
 ```
 
+For convenience, you can also define your own factory classes.
+
+```ruby
+class AutomobileFactory
+  extend Industrialist::Factory
+
+  manufactures Automobile
+end
+
+AutomobileFactory.build(:sedan)  # => #<Sedan:0x00007ff64d88ce58>
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -175,16 +184,13 @@ Or install it yourself as:
 
     $ gem install industrialist
 
-If you are using Industrialist with Rails, you'll need to preload your manufacturable objects in the development and test environments in an intializer, like this:
+If you are using Industrialist with Rails, you'll need to
 
 ```ruby
-def require_factory(class_type)
-  Dir[Rails.root.join('app', "#{class_type}", '**', '*.rb').to_s].each { |file| require file }
-end
-
-if %w(development test).include?(Rails.env)
-  require_factory('automobiles')
-  require_factory('books')
+Industrialist.config do |config|
+  config.manufacturable_paths << Rails.root.join('app', 'planes')
+  config.manufacturable_paths << Rails.root.join('app', 'trains')
+  config.manufacturable_paths << Rails.root.join('app', 'automobiles')
 end
 ```
 

data/example/airplanes/airplane.rb

@@ -0,0 +1,7 @@
+class Airplane
+  extend Industrialist::Manufacturable
+
+  def info
+    puts self.class.name
+  end
+end

data/example/airplanes/airplane_factory.rb

@@ -0,0 +1,7 @@
+require_relative 'airplane'
+
+class AirplaneFactory
+  extend Industrialist::Factory
+
+  manufactures Airplane
+end

data/example/airplanes/f16_tomcat.rb

@@ -0,0 +1,6 @@
+require_relative 'airplane'
+
+class F16Tomcat < Airplane
+  corresponds_to :f16
+  corresponds_to :tomcat
+end

data/example/airplanes/p51_mustang.rb

@@ -0,0 +1,6 @@
+require_relative 'airplane'
+
+class P51Mustang < Airplane
+  corresponds_to :p51
+  corresponds_to :mustang
+end

data/example/app.rb

@@ -0,0 +1,15 @@
+require 'industrialist'
+
+Industrialist.config do |config|
+  config.manufacturable_paths << "#{File.dirname(__FILE__)}/automobiles"
+  config.manufacturable_paths << "#{File.dirname(__FILE__)}/airplanes"
+end
+
+AutomobileFactory.build(:sedan).info
+AutomobileFactory.build(:convertible).info
+AutomobileFactory.build(:cabriolet).info
+
+AirplaneFactory.build(:f16).info
+AirplaneFactory.build(:tomcat).info
+AirplaneFactory.build(:p51).info
+AirplaneFactory.build(:mustang).info

data/example/automobiles/automobile.rb

@@ -0,0 +1,7 @@
+class Automobile
+  extend Industrialist::Manufacturable
+
+  def info
+    puts self.class.name
+  end
+end

data/example/automobiles/automobile_factory.rb

@@ -0,0 +1,7 @@
+require_relative 'automobile'
+
+class AutomobileFactory
+  extend Industrialist::Factory
+
+  manufactures Automobile
+end

data/example/automobiles/convertible.rb

@@ -0,0 +1,6 @@
+require_relative 'automobile'
+
+class Convertible < Automobile
+  corresponds_to :convertible
+  corresponds_to :cabriolet
+end

data/example/automobiles/sedan.rb

@@ -0,0 +1,5 @@
+require_relative 'automobile'
+
+class Sedan < Automobile
+  corresponds_to :sedan
+end

data/lib/industrialist/builder.rb

@@ -0,0 +1,14 @@
+require 'industrialist/registrar'
+
+module Industrialist
+  class Builder
+    def self.build(type, key, *args)
+      klass = Registrar.value_for(type, key)
+      Object.const_get(klass.name)&.new(*args) unless klass.nil?
+    end
+  end
+
+  def self.build(*args)
+    Builder.build(*args)
+  end
+end

data/lib/industrialist/config.rb

@@ -0,0 +1,27 @@
+module Industrialist
+  class Config
+    class << self
+      attr_writer :require_method
+
+      def manufacturable_paths
+        @manufacturable_paths ||= []
+      end
+
+      def load_manufacturables
+        manufacturable_paths.each { |path| Dir["#{path}/**/*.rb"].each { |file| Kernel.public_send(require_method, file) } }
+      end
+
+      private
+
+      def require_method
+        @require_method || :require
+      end
+    end
+  end
+
+  def self.config
+    yield(Config)
+
+    Config.load_manufacturables
+  end
+end

data/lib/industrialist/factory.rb

@@ -1,26 +1,15 @@
-module Industrialist
-  class Factory
-    DEFAULT_KEY = :__manufacturable_default__
-
-    attr_reader :registry
-
-    def initialize
-      @registry = {}
-    end
+require 'industrialist/builder'
 
-    def register(key, klass)
-      registry[factory_key(key)] = klass
+module Industrialist
+  module Factory
+    def manufactures(klass)
+      @type = Type.industrialize(klass)
     end
 
     def build(key, *args)
-      klass = registry[factory_key(key)] || registry[DEFAULT_KEY]
-      klass&.new(*args)
-    end
-
-    private
+      return if @type.nil?
 
-    def factory_key(key)
-      (key.respond_to?(:to_sym) && key.to_sym) || key
+      Builder.build(@type, key, *args)
     end
   end
 end

data/lib/industrialist/manufacturable.rb

@@ -1,36 +1,18 @@
-require 'industrialist/factory'
-require 'industrialist/warning_helper'
+require 'industrialist/registrar'
+require 'industrialist/type'
 
 module Industrialist
   module Manufacturable
-    ALREADY_INCLUDED_WARNING_MESSAGE = 'warning: overriding previously defined factory on this class hierarchy'.freeze
-    MULTIPLE_DEFAULT_WARNING_MESSAGE = 'warning: overriding a previously registered default class'.freeze
-
-    def self.included(base)
-      WarningHelper.warning(ALREADY_INCLUDED_WARNING_MESSAGE) if base.class_variable_defined?(:@@factory)
-
-      base.extend ClassMethods
-      base.class_variable_set(:@@factory, Industrialist::Factory.new)
+    def self.extended(base)
+      base.class_variable_set(:@@type, Type.industrialize(base))
     end
 
-    module ClassMethods
-      def create_factory(identifier)
-        Object.const_set(identifier, factory)
-      end
-
-      def corresponds_to(key)
-        factory.register(key, self)
-      end
-
-      def manufacturable_default
-        WarningHelper.warning(MULTIPLE_DEFAULT_WARNING_MESSAGE) if factory.registry[Industrialist::Factory::DEFAULT_KEY]
-
-        factory.register(Industrialist::Factory::DEFAULT_KEY, self)
-      end
+    def corresponds_to(key)
+      Registrar.register(self.class_variable_get(:@@type), key, self)
+    end
 
-      def factory
-        class_variable_get(:@@factory)
-      end
+    def manufacturable_default
+      Registrar.register_default(self.class_variable_get(:@@type), self)
     end
   end
 end

data/lib/industrialist/railtie.rb

@@ -0,0 +1,9 @@
+require 'industrialist/config'
+
+module Industrialist
+  class Railtie < Rails::Railtie
+    initializer "industrialist.configure_rails_initialization" do |app|
+      Industrialist::Config.require_method = app.config.eager_load ? :require : :require_dependency
+    end
+  end
+end

data/lib/industrialist/registrar.rb

@@ -0,0 +1,56 @@
+require 'industrialist/type'
+require 'industrialist/warning_helper'
+
+module Industrialist
+  class Registrar
+    DEFAULT_KEY = :__manufacturable_default__
+    REDEFINED_KEY_WARNING_MESSAGE = 'warning: overriding a previously registered class'.freeze
+    REDEFINED_DEFAULT_WARNING_MESSAGE = 'warning: overriding a previously registered default class'.freeze
+
+    class << self
+      def register(type, key, klass)
+        WarningHelper.warning(REDEFINED_KEY_WARNING_MESSAGE) if overriding?(type, key, klass)
+
+        registry[type][key] = klass
+      end
+
+      def register_default(type, klass)
+        WarningHelper.warning(REDEFINED_DEFAULT_WARNING_MESSAGE) if overriding?(type, DEFAULT_KEY, klass)
+
+        registry[type][DEFAULT_KEY] = klass
+      end
+
+      def value_for(type, key)
+        return unless registry.key?(type)
+
+        registry[type][key] || registry[type][DEFAULT_KEY]
+      end
+
+      def registered_types
+        registry.keys
+      end
+
+      def registered_keys(type)
+        registry[type].keys
+      end
+
+      private
+
+      def overriding?(type, key, klass)
+        !registry[type][key].nil? && registry[type][key].name != klass.name
+      end
+
+      def registry
+        @registry ||= Hash.new { |hash, key| hash[key] = {} }
+      end
+    end
+  end
+
+  def self.registered_types
+    Registrar.registered_types
+  end
+
+  def self.registered_keys(type)
+    Registrar.registered_keys(type)
+  end
+end

data/lib/industrialist/type.rb

@@ -0,0 +1,23 @@
+module Industrialist
+  class Type
+    def self.industrialize(klass)
+      str = klass.name
+      str = separate_lowercase_or_number_from_uppercase_letters(str)
+      str = separate_numbers_from_letters(str)
+      str = separate_last_consecutive_uppercase_letter_when_followed_by_lowercase_letter(str)
+      str.downcase.to_sym
+    end
+
+    def self.separate_lowercase_or_number_from_uppercase_letters(string)
+      string.gsub(/[a-z0-9][A-Z]+/) { |s| "#{s[0]}_#{s[1..-1]}" }
+    end
+
+    def self.separate_numbers_from_letters(string)
+      string.gsub(/[a-zA-Z][0-9]+/) { |s| "#{s[0]}_#{s[1..-1]}" }
+    end
+
+    def self.separate_last_consecutive_uppercase_letter_when_followed_by_lowercase_letter(string)
+      string.gsub(/[A-Z][A-Z]+[a-z]/) { |s| "#{s[0..-3]}_#{s[-2..-1]}" }
+    end
+  end
+end

data/lib/industrialist/version.rb

@@ -1,3 +1,3 @@
 module Industrialist
-  VERSION = '0.4.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/industrialist/warning_helper.rb

@@ -1,10 +1,7 @@
 module Industrialist
   class WarningHelper
     def self.warning(message)
-      most_recent_caller = caller(2..2).first.split(':')
-      file_name = most_recent_caller[0]
-      line_number = most_recent_caller[1]
-      warn("#{file_name}:#{line_number}: #{message}")
+      warn("#{caller(3..3).first}: #{message}")
     end
   end
 end

data/lib/industrialist.rb

@@ -1,2 +1,5 @@
 require "industrialist/version"
+require "industrialist/config"
 require "industrialist/manufacturable"
+require "industrialist/factory"
+require 'industrialist/railtie' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: industrialist
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,10 +102,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example/airplanes/airplane.rb
+- example/airplanes/airplane_factory.rb
+- example/airplanes/f16_tomcat.rb
+- example/airplanes/p51_mustang.rb
+- example/app.rb
+- example/automobiles/automobile.rb
+- example/automobiles/automobile_factory.rb
+- example/automobiles/convertible.rb
+- example/automobiles/sedan.rb
 - industrialist.gemspec
 - lib/industrialist.rb
+- lib/industrialist/builder.rb
+- lib/industrialist/config.rb
 - lib/industrialist/factory.rb
 - lib/industrialist/manufacturable.rb
+- lib/industrialist/railtie.rb
+- lib/industrialist/registrar.rb
+- lib/industrialist/type.rb
 - lib/industrialist/version.rb
 - lib/industrialist/warning_helper.rb
 homepage: https://github.com/entelo/industrialist