trax_core 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2334732a821d9d5056751539fdbeb5ab00ee3a2
-  data.tar.gz: 47e1f9e17b35b99e089f7df3a1c7c67224af640e
+  metadata.gz: a0ab417a5f629ffa26dd2ed8aa06606ad0ef8da8
+  data.tar.gz: 0e40b82964838f3a67ce14188f88fa50a3f53b6b
 SHA512:
-  metadata.gz: 583a45ddb697ab1b3c006262efddeb7dd18c6362f62a5d8c79dd70b1662d29ea19c3f87bd491e965f567a6aa271b2e455235fc6932f6e30865bd776de679fedd
-  data.tar.gz: df8fabe5f2e320dd3a59fa5aa949bd6ad1b48acb5d97cf04af62f0260a59d774b58fccc6b85d89d9a1f9c9755a937817ca42c527b1284bb534617673eb9ff0f4
+  metadata.gz: 0fb3074b04d8a8d4aef67b29c74d0d26fdaf448aeef86e4840a41fd123f6882fce2d93257022440aab3f60678617166ce20e913cef86ebd92595c6fb5af7ced6
+  data.tar.gz: cb0cc1e316457f2d1a8b62eca08c36de77011b8c752ab7fe364107f40a7b093b245f56de65c8acc90e6400877a5cd690406b80d1a6be2ae9230d972f0ec74e04

data/lib/trax/core.rb

@@ -1,10 +1,14 @@
 require 'active_support/all'
 require_relative './array'
+require_relative './core/ext/module'
+require_relative './core/ext/object'
 
 module Trax
   module Core
     extend ::ActiveSupport::Autoload
 
+    autoload :Configuration
     autoload :EagerAutoloadNamespace
+    autoload :Errors
   end
 end

data/lib/trax/core/configuration.rb

@@ -0,0 +1,45 @@
+require 'hashie/dash'
+require 'active_model'
+require 'active_model/validations'
+
+module Trax
+  module Core
+    class Configuration
+      include ActiveModel::Validations
+
+      def initialize
+        set_default_values
+
+        yield self
+
+        raise_errors unless self.valid?
+      end
+
+      def set_default_values
+        self.class.configurable_options.select{|attr_name, hash| hash.key?(:default) }.each_pair do |attr_name,hash|
+          __send__("#{attr_name}=", hash[:default])
+        end
+      end
+
+      def self.inherited(subklass)
+        subklass.class_attribute :configurable_options
+        subklass.configurable_options = {}
+      end
+
+      def self.option(attr_name, options = {})
+        attr_accessor attr_name
+
+        validates_presence_of(attr_name) if(options.key?(:required))
+
+        self.configurable_options[attr_name] = options
+      end
+
+      def raise_errors
+        raise Trax::Core::Errors::ConfigurationError.new(
+          :messages => self.errors.full_messages,
+          :source => self.class.name
+        )
+      end
+    end
+  end
+end

data/lib/trax/core/errors.rb

@@ -0,0 +1,97 @@
+require 'hashie/dash'
+require 'hashie/mash'
+
+module Trax
+  module Core
+    module Errors
+      # A simple inheritable error class
+      # Because Im sick of defining in every project a base error class
+      # and IMO arguments should have explicit names when thrown to give context to the error
+      # (while not being order dependent)
+      # and perhaps its a bad idea to require arguments when throwing errors, but
+      # you can still make them as generic as you want
+      # & the idea is fail fast and provide more targeted & descriptive error tracking data
+
+      # Example:
+      #
+      #  class AbstractInstanceMethodNotDefined < ::Trax::Core::Errors::Base
+      #    argument :method_name, :required => true
+      #    argument :klass, :required => true
+      #
+      #    message {
+      #      "Abstract instance method, #{method_name} not defined for #{klass}"
+      #    }
+      #  end
+      #
+      #  raise ::AbstractInstanceMethodNotDefined.new(:method_name => "my_method", :klass => self.class.name)
+
+      class Arguments < ::Hashie::Dash
+      end
+
+      class Base < StandardError
+        class_attribute :_message
+
+        #on inherit of Trax::Core::Errors::Base, inherit from arguments class above to provide simple
+        #dsl options / typecasting and stuff to our errors.
+        def self.inherited(subklass)
+          subklass.class_eval do
+            arguments_class_name = "#{subklass.name.demodulize}Arguments"
+            arguments_klass = const_set(arguments_class_name, ::Class.new(::Trax::Core::Errors::Arguments)) unless const_defined?(arguments_class_name)
+            @_permitted_arguments_klass = arguments_klass
+            @_permitted_arguments = arguments_klass.new
+
+            attr_reader :_permitted_arguments
+            attr_reader :_permitted_arguments_klass
+          end
+        end
+
+        def self.argument(method_name, *args)
+          permitted_arguments_klass.property(method_name, *args)
+
+          define_method(method_name) do
+            arguments_instance.__send__(method_name)
+          end
+        end
+
+        def self.permitted_arguments_klass
+          @_permitted_arguments_klass
+        end
+
+        def self.permitted_arguments
+          @_permitted_arguments
+        end
+
+        def self.message(&block)
+          self._message = block
+        end
+
+        # if no properties have been defined using argument method, wrap in Mash
+        def self.error_arguments_klass
+          @error_arguments_klass ||= (permitted_arguments_klass.properties.length) ? permitted_arguments_klass : ::Hashie::Mash
+        end
+
+        attr_reader :arguments_instance
+
+        def initialize(_attributes = {})
+          @arguments_instance = self.class.permitted_arguments_klass.new(_attributes)
+
+          super(message)
+        end
+
+        def message
+          self.instance_eval(&self.class._message)
+        end
+      end
+
+      class ConfigurationError < ::Trax::Core::Errors::Base
+        argument :source, :required => true
+        argument :messages
+
+        message {
+          "Error configuring #{source}, \n" \
+          "#{messages.join('\n')}"
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+class Module
+  def recursively_define_namespaced_class(class_name, class_to_inherit_from = Object)
+    paths = class_name.split("::")
+    const_name = paths.shift
+
+    if paths.length > 0
+      self.const_set(const_name, ::Module.new) unless self.constants.include?(:"#{const_name}")
+      "#{self.name}::#{const_name}".safe_constantize.recursively_define_namespaced_class(paths.join("::"), class_to_inherit_from)
+    else
+      self.const_set(const_name, ::Class.new(class_to_inherit_from)) unless self.constants.include?(:"#{const_name}")
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require "active_support/core_ext/object/try"
+
+class Object
+  # Defines a Configuration Class within a target module namespace, or nested class
+  # i.e. configuration_for(::Ecommerce::Cart) will define
+  # Ecommerce::Cart::Configuration class, inherited form Trax::Core::Configuration
+  # And we can then define specific configuration options, for that class, on that class
+  def configuration_for(target, &blk)
+    target.class_eval do
+      class << self
+        attr_accessor :_configuration
+      end
+
+      const_set("Configuration", ::Class.new(::Trax::Core::Configuration))
+      const_get("Configuration").instance_eval(&blk)
+
+      def self.configure(&block)
+        @_configuration = const_get("Configuration").new(&block)
+      end
+
+      def self.config
+        _configuration
+      end
+    end
+  end
+
+  def define_configuration_options(&block)
+    configuration_for(self, &block)
+  end
+
+  alias_method :define_configuration, :define_configuration_options
+  alias_method :has_configuration, :define_configuration_options
+
+  #following method stolen from abrandoned https://rubygems.org/gems/try_chain
+  def try_chain(*symbols)
+    return nil if self.nil?
+
+    symbols = symbols.flatten
+    symbols.compact!
+
+    symbols.reduce(self) do |result, symbol|
+      result = result.try(symbol)
+      break nil if result.nil?
+      result
+    end
+  end
+end

data/lib/trax_core.rb

@@ -1,4 +1,5 @@
 require_relative './trax'
+require 'hashie'
 
 module TraxCore
 

data/lib/trax_core/version.rb

@@ -1,3 +1,3 @@
 module TraxCore
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/support/errors.rb

@@ -0,0 +1,11 @@
+module Errors
+  class SiteBrokenError < ::Trax::Core::Errors::Base
+    argument :request_url, :required => true
+    argument :request_id, :required => true
+
+    message {
+      "Oh no, the site broke on #{request_url}" \
+      "for current_request_id #{request_id}!"
+    }
+  end
+end

data/spec/trax/core/errors_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ::Trax::Core::Errors do
+  subject { ::Errors::SiteBrokenError }
+
+  it { expect{ subject.new }.to raise_error(ArgumentError) }
+
+  it do
+    expect do
+      raise subject.new(
+        :request_url => 'http://www.somewhere.com',
+        :request_id => 'asdasdsdad1231421'
+      )
+    end.to raise_error(subject)
+  end
+
+  it do
+    subject.new(
+      :request_url => 'http://www.somewhere.com',
+      :request_id => 'asdasdsdad1231421'
+    ).to_s.should include('http://www.somewhere.com')
+  end
+end

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

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe ::Module do
+  subject { Trax::Core }
+
+  describe ".recursively_define_namespaced_class" do
+    context "when class namespace does not exist at global module level" do
+      before do
+        Trax.recursively_define_namespaced_class("Somefake::Thing")
+      end
+
+      it { Trax::Somefake::Thing.class == Object }
+    end
+
+    context "when class namespace does exist at global module level" do
+      before do
+        Trax.recursively_define_namespaced_class("Core::FakeKlass", Hash)
+      end
+
+      it { Trax::Core::FakeKlass.superclass.should == Hash }
+    end
+  end
+
+  describe ".configuration_for" do
+    before do
+      ::Trax.recursively_define_namespaced_class("Core::FakeNamespace", Module)
+
+      ::Trax::Core::FakeNamespace.configuration_for(Trax::Core::FakeNamespace) do
+        option :something, :required => true
+      end
+    end
+
+    subject{ ::Trax::Core::FakeNamespace::Configuration }
+
+    its(:superclass) { should eq ::Trax::Core::Configuration }
+
+    it "sets up configuration options" do
+      ::Trax::Core::FakeNamespace.configure do |config|
+        config.something = 'anything'
+      end
+
+      ::Trax::Core::FakeNamespace.config.something.should eq 'anything'
+    end
+  end
+
+  describe ".configuration_options" do
+    before do
+      ::Trax.recursively_define_namespaced_class("Core::SomeFakeKlass", Hash)
+
+      ::Trax::Core::SomeFakeKlass.define_configuration_options do
+        option :base_url, :required => true
+        option :subdomains, :default => []
+      end
+    end
+
+    it "blows up if required and not set" do
+      expect {
+        ::Trax::Core::SomeFakeKlass.configure do |config|
+          config.subdomains = [:blah, :blah]
+        end
+
+      }.to raise_error(Trax::Core::Errors::ConfigurationError)
+    end
+
+    it "sets defaults" do
+      ::Trax.recursively_define_namespaced_class("Core::YetAnotherFakeClass", Hash)
+
+      Trax::Core::YetAnotherFakeClass.define_configuration_options do
+        option :base_url
+        option :allowed_ips, :default => [ '192.231.1234' ]
+      end
+
+      ::Trax::Core::YetAnotherFakeClass.configure do |config|
+        config.base_url = 'somewhere'
+      end
+
+      ::Trax::Core::YetAnotherFakeClass.config.allowed_ips[0].should eq '192.231.1234'
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe ::Object do
+  before do
+    class SomeFakeClass < OpenStruct
+    end
+  end
+
+  subject do
+    SomeFakeClass
+  end
+
+  describe ".try_chain" do
+    it "wraps multiple calls to try and calls try on return value" do
+      subject.try_chain(:name, :underscore).should eq "some_fake_class"
+    end
+
+    it "handles return if nil is in chain" do
+      subject.try_chain(:name, :somefakemethod).should be_nil
+    end
+
+    it "handles instances of class" do
+      SomeFakeClass.new.try_chain(:class, :name, :underscore).should eq "some_fake_class"
+    end
+  end
+end

data/trax_core.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "hashie"
   spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trax_core
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -251,15 +265,23 @@ files:
 - lib/trax.rb
 - lib/trax/array.rb
 - lib/trax/core.rb
+- lib/trax/core/configuration.rb
 - lib/trax/core/eager_autoload_namespace.rb
+- lib/trax/core/errors.rb
+- lib/trax/core/ext/module.rb
+- lib/trax/core/ext/object.rb
 - lib/trax_core.rb
 - lib/trax_core/version.rb
 - spec/spec_helper.rb
 - spec/support/ecom.rb
 - spec/support/ecom/widget.rb
 - spec/support/ecom/widget_category.rb
+- spec/support/errors.rb
 - spec/trax/array_spec.rb
 - spec/trax/core/eager_autoload_namespace_spec.rb
+- spec/trax/core/errors_spec.rb
+- spec/trax/core/ext/module_spec.rb
+- spec/trax/core/ext/object_spec.rb
 - spec/trax/core_spec.rb
 - trax_core.gemspec
 homepage: http://github.com/jasonayre/trax_core
@@ -282,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Core Trax Dependencies
@@ -291,6 +313,10 @@ test_files:
 - spec/support/ecom.rb
 - spec/support/ecom/widget.rb
 - spec/support/ecom/widget_category.rb
+- spec/support/errors.rb
 - spec/trax/array_spec.rb
 - spec/trax/core/eager_autoload_namespace_spec.rb
+- spec/trax/core/errors_spec.rb
+- spec/trax/core/ext/module_spec.rb
+- spec/trax/core/ext/object_spec.rb
 - spec/trax/core_spec.rb