trax_core 0.0.72 → 0.0.73

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6d1154c6a3219971c25e70ac2c4a820f313740d
-  data.tar.gz: ba70a2bd38733dc7c401d4750e1ce4f86313df9c
+  metadata.gz: c5024434d1d908d0f3b6e774057686b2f10c1672
+  data.tar.gz: c5b7c340a2ffbcaac6a1c5657bff2d4654a9e0b4
 SHA512:
-  metadata.gz: 9c3ef17bf573140d83ab0d9f7f67de7d3d6c70174f28fca5db8c38cfb2fa19f7fc06c0be3165499e55820773360dd2769e75313c758c9e121aed3cb3067ef2a2
-  data.tar.gz: df4bb2354da8d72a729e951193dbe2d640c8d4b6c6b6a8ebd4e446025d726858e68a0802aa2325a425795125d0bf2c2e4e5026467df66c1473a1cdbaebb49cb8
+  metadata.gz: 28e0707812c88b6ac6f99e6ee12122974154b291df3b598d72439769f52777be27df26d5f6a2f3928bb7f1dc2a7ec17f79f05e31ad62332724e180ff362ce282
+  data.tar.gz: a292fc41a2b4df6e62e7b5ed56849fa3cbae16687fddb03e90b4bfb918516ec927b855e7d0fd53f572a1139b2515349bc95040285b2d4965db04b3f3c9f95359

data/README.md

@@ -2,43 +2,77 @@
 
 The active support for Trax / Trax components.
 
-### EagerAutoloadNamespace
+## Trax::Core::NamedClass
+**Create a non anonymous class via a fully qualified class name**
+*note namespace it is created in must exist prior to creation*
 
-Wish you could eager load all of the paths in a particular namespace directory,
-eagerly? Say you have the following directory tree you're trying to autoload:
+Trax::Core::NamedClass.new instead of Class.new differences
 
-whatever.rb
+1. Defines class within namespace, so no thing = some_module.const_set("Blah", Class.new) needed
+2. Allows you to access the created class name within the definition block, i.e.
 ``` ruby
-module Whatever
-  extend ::ActiveSupport::Autoload
+myklass = some_module.const_set("Blah", Class.new do
+  puts name
+end)
+=> nil
+```
 
-  eager_autoload do
-    autoload :Widget
-    autoload :Thing
-  end
+Will put nil, as its referencing the anonymous class. However:
+``` ruby
+::Trax::Core::NamedClass.new("SomeModule::Blah") do
+  puts name
 end
-
-Whatever.eager_load!
+=> "SomeModule::Blah"
 ```
-whatever/widget.rb
+Holds reference to actual class being created.
+
+3. Allows you to pass an options hash which gets evaluated as class_attribute accessor
+
 ``` ruby
-module Whatever
-  module Widget
+module Html
+  class Element
   end
 end
+
+::Trax::Core::NamedClass.new(
+  "Html::DivWithDimensions",
+  Html::Element,
+  :default_height => "220px",
+  :default_width => "220px"
+)
+
+Html::Div.default_height => "220px"
+Html::Div.default_width => "220px"
 ```
 
-Now you just have to do:
+^ is probably a bad example, but you get the idea. Also note param 2 is the class you
+want to inherit from, which differs from the Class.new api which expects 1st param
+to be the class you are inheriting from. Broke from that api since its optional,
+and the thing that is not optional with a named class, is obviously the name.
 
+## Trax::Core::NamedModule
+**Create a non anonymous module via a fully qualified module name**
+*note namespace it is created in must exist prior to creation*
+
+### examples: (by default, any module args passed after the name of the module will be applied via extend)
+**With Args:**
 ``` ruby
-module Whatever
-  include ::Trax::Core::EagerAutoloadNamespace
-end
+Trax::Core::NamedModule.new("Ecommerce::ItemExtensions", PricingExtension, ShippingExtension)
+
+=> mod = Ecommerce.const_set("ItemExtensions")
+   mod.extend(PricingExtension)
+   mod.extend(ShippingExtension)
 ```
 
-Note, it cant handle all caps namespaces, i.e. it would break if namespace were WIDGETS,
-as it just uses classify on the file base name to define the autoload block.
+**With :extensions keyword**
+``` ruby
+Trax::Core::NamedModule.new("Ecommerce::ItemExtensions", :extensions => [::Ecommerce::PricingExtension])
+```
 
+**With :includes keyword**
+``` ruby
+Trax::Core::NamedModule.new("Ecommerce::ItemExtensions", :includes => [::Ecommerce::ShippingExtension])
+```
 
 ## Installation
 

data/lib/trax/core/ext/object.rb

@@ -1,5 +1,4 @@
 require "active_support/core_ext/object/try"
-
 class Object
   def as!
     yield self
@@ -57,6 +56,15 @@ class Object
   end
   alias_method :reset_instance_variables, :remove_instance_variables
 
+  def set_fully_qualified_constant(const_name, value)
+    segs = const_name.split("::")
+
+    raise(::StandardError.new("Set fully qualified constant requires a preexisting namespace to set under")) unless segs.length > 1
+
+    as, on = segs.pop, segs.join("::").constantize
+    on.const_set(as, value)
+  end
+
   #following method stolen from abrandoned https://rubygems.org/gems/try_chain
   def try_chain(*symbols)
     return nil if self.nil?

data/lib/trax/core/named_class.rb

@@ -0,0 +1,20 @@
+module Trax
+  module Core
+    class NamedClass
+      def self.new(_name, _parent_klass=nil, **options, &block)
+        klass = ::Object.set_fully_qualified_constant(_name, (_parent_klass ? ::Class.new(_parent_klass) : Class.new do
+          define_singleton_method(:name) { _name }
+
+          options.each_pair do |k,v|
+            self.class.class_attribute k
+            self.__send__("#{k}=", v)
+          end
+        end))
+
+        klass.instance_eval(&block) if block_given?
+
+        klass
+      end
+    end
+  end
+end

data/lib/trax/core/named_module.rb

@@ -0,0 +1,31 @@
+module Trax
+  module Core
+    module NamedModule
+      # examples: (by default, any module args passed after the name of the module will be applied via extend)
+      # With Args:
+      # Trax::Core::NamedModule.new("Ecommerce::ItemExtensions", ::Ecommerce::PricingExtension, Ecommerce::ShippingExtension)
+      # With :extensions keyword
+      # Trax::Core::NamedModule.new("Ecommerce::ItemExtensions", :extensions => [::Ecommerce::PricingExtension])
+      # With :includes keyword
+      # Trax::Core::NamedModule.new("Ecommerce::ItemExtensions", :includes => [::Ecommerce::ShippingExtension])
+
+      def self.new(_name, *_extensions, **options, &block)
+        module_object = ::Object.set_fully_qualified_constant(_name, ::Module.new do
+          define_singleton_method(:name) do
+            _name
+          end
+        end)
+
+        module_object.module_eval(&block) if block_given?
+
+        includes = [options.extract!(:includes).fetch(:includes) { nil }].compact.flatten
+        extensions = [options.extract!(:extensions).fetch(:extensions) { nil }, _extensions].compact.flatten
+
+        extensions.each_with_object(module_object) { |ext, mod| mod.extend(ext) } if extensions.length
+        includes.each_with_object(module_object){ |ext, mod| mod.include(ext) } if includes.length
+
+        module_object
+      end
+    end
+  end
+end

data/lib/trax/core.rb

@@ -29,5 +29,7 @@ module Trax
     autoload :InheritanceHooks
     autoload :Mixin
     autoload :Mixable
+    autoload :NamedClass
+    autoload :NamedModule
   end
 end

data/lib/trax_core/version.rb

@@ -1,3 +1,3 @@
 module TraxCore
-  VERSION = "0.0.72"
+  VERSION = "0.0.73"
 end

data/spec/support/fake_namespace/named_class_support.rb

@@ -0,0 +1,9 @@
+::Trax::Core::NamedClass.new("FakeNamespace::Something", String)
+::Trax::Core::NamedClass.new("FakeNamespace::SomeBlankClass")
+::Trax::Core::NamedClass.new("FakeNamespace::Dmx") do
+  class_attribute :whats_my_name
+
+  self.whats_my_name = self.name.underscore
+end
+
+::Trax::Core::NamedClass.new("FakeNamespace::ClassWithAttributes", :length => 20, :height => 15)

data/spec/support/fake_namespace/named_module_support.rb

@@ -0,0 +1,21 @@
+module PricingExtension
+  BASE_PRICE = "0.00"
+
+  def price
+    "9.99"
+  end
+end
+
+module ShippingExtension
+  def shipping
+    "9.99"
+  end
+end
+
+::Trax::Core::NamedModule.new("FakeNamespace::Ecommerce", PricingExtension, ShippingExtension) do
+  def self.some_method
+    "blah"
+  end
+end
+
+::Trax::Core::NamedModule.new("FakeNamespace::ThingWithIncludes", :includes => [PricingExtension])

data/spec/trax/core/ext/object_spec.rb

@@ -24,6 +24,17 @@ describe ::Object do
     end
   end
 
+  describe ".set_fully_qualified_constant" do
+    it "sets a fully qualified constant" do
+      result = Object.set_fully_qualified_constant("SomeFakeClass::SomeFakeNestedClass", Class.new)
+      result.name.should eq "SomeFakeClass::SomeFakeNestedClass"
+    end
+
+    it "raises error if no valid namespace to set constant upon is passed" do
+      expect{Object.set_fully_qualified_constant("SomeFakeNestedClass", Class.new)}.to raise_error(StandardError)
+    end
+  end
+
   describe ".remove_instance_variables" do
     it "reset instance variables by symbol names" do
       obj = SomeFakeClass.new

data/spec/trax/core/named_class_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ::Trax::Core::NamedClass do
+  let(:fake_klass_name) { "FakeNamespace::Something" }
+  subject { Object.const_get(fake_klass_name) }
+
+  it { expect(subject.superclass).to eq ::String }
+  it { expect(subject.name).to eq fake_klass_name }
+
+  context "Does not inherit from another class" do
+    let(:fake_klass_name) { "FakeNamespace::SomeBlankClass" }
+
+    it { expect(subject.name).to eq fake_klass_name }
+    it { expect(subject.superclass).to eq ::Object }
+  end
+
+  context "Created class can reference its given class name when defining behavior" do
+    let(:fake_klass_name) { "FakeNamespace::Dmx" }
+
+    it { expect(subject.whats_my_name).to eq "fake_namespace/dmx" }
+  end
+
+  context "Created class accepts an options hash which defines its own attribute set at creation" do
+    let(:fake_klass_name) { "FakeNamespace::ClassWithAttributes" }
+
+    it { expect(subject.length).to eq 20 }
+    it { expect(subject.height).to eq 15 }
+  end
+end

data/spec/trax/core/named_module_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe ::Trax::Core::NamedModule do
+  let(:fake_module_name) { "FakeNamespace::Ecommerce" }
+  subject { Object.const_get(fake_module_name) }
+
+  it { expect(subject).to respond_to(:price) }
+  it { expect(subject).to respond_to(:shipping) }
+  it { expect(subject.some_method).to eq "blah" }
+
+  context "includes" do
+    let(:fake_module_name) { "FakeNamespace::ThingWithIncludes" }
+    it { expect(subject::BASE_PRICE).to eq "0.00" }
+  end
+end

data/trax_core.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   # spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-pride"
-  # spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency 'rspec-its', '~> 1'
   spec.add_development_dependency 'rspec-collection_matchers', '~> 1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trax_core
 version: !ruby/object:Gem::Version
-  version: 0.0.72
+  version: 0.0.73
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +203,8 @@ files:
 - lib/trax/core/isolated_mixin.rb
 - lib/trax/core/mixable.rb
 - lib/trax/core/mixin.rb
+- lib/trax/core/named_class.rb
+- lib/trax/core/named_module.rb
 - lib/trax/core/primitives/enum.rb
 - lib/trax/core/primitives/enum_value.rb
 - lib/trax_core.rb
@@ -200,6 +216,8 @@ files:
 - spec/support/ecom/widget_category.rb
 - spec/support/errors.rb
 - spec/support/fake_namespace.rb
+- spec/support/fake_namespace/named_class_support.rb
+- spec/support/fake_namespace/named_module_support.rb
 - spec/support/fake_namespace/priceable.rb
 - spec/support/inheritance_chain_namespace.rb
 - spec/support/some_mixin.rb
@@ -217,6 +235,8 @@ files:
 - spec/trax/core/ext/uri_spec.rb
 - spec/trax/core/has_mixins_spec.rb
 - spec/trax/core/inheritance_spec.rb
+- spec/trax/core/named_class_spec.rb
+- spec/trax/core/named_module_spec.rb
 - spec/trax/core_spec.rb
 - spec/trax/enum_spec.rb
 - spec/trax/hash_spec.rb
@@ -253,6 +273,8 @@ test_files:
 - spec/support/ecom/widget_category.rb
 - spec/support/errors.rb
 - spec/support/fake_namespace.rb
+- spec/support/fake_namespace/named_class_support.rb
+- spec/support/fake_namespace/named_module_support.rb
 - spec/support/fake_namespace/priceable.rb
 - spec/support/inheritance_chain_namespace.rb
 - spec/support/some_mixin.rb
@@ -270,6 +292,8 @@ test_files:
 - spec/trax/core/ext/uri_spec.rb
 - spec/trax/core/has_mixins_spec.rb
 - spec/trax/core/inheritance_spec.rb
+- spec/trax/core/named_class_spec.rb
+- spec/trax/core/named_module_spec.rb
 - spec/trax/core_spec.rb
 - spec/trax/enum_spec.rb
 - spec/trax/hash_spec.rb