shamu 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17432a9ad613be127cf8fcd337ff0783499ce17f
-  data.tar.gz: 9781a19889f10541dc79a2ff2d9be287c7bf5c79
+  metadata.gz: 27e560182b114ef221743131ca89ac18601cfbf7
+  data.tar.gz: c6fd668c63413a9d45cefe73b87a587240ee5c8c
 SHA512:
-  metadata.gz: 0063e5b0ecec7d70a54b3131f923e04c944c946f4f42940fe081a53e36e31ccc95e7b5b01adc4eef123013b444c4d9a93aac504954fe44b98702ffe92cb5bb2f
-  data.tar.gz: cb725d193fe76f76517b3a3d57dbf159154e8591c7cac18e681711690b5dc8bae71afb5cb4dd3844d7e552481f57990f83647eb85b25863b3b100e1610c15870
+  metadata.gz: 31814221203809e5be4e532732c4f01d0f6c2583dc197bf4025efb8f1ae0e6e69c45707d5b7d553ea87e555767bf56a7efc29c910b1ea1245ac62283f3e5602d
+  data.tar.gz: 915d74f223c593d04dc7b5d79629d7207d26fd5238956c52bf43f03cfd2bf20915ba59fedafd6249b19a0c00792952aa9e4d62638af880fe0d7e5d13702ce7aa

data/.codeclimate.yml

@@ -0,0 +1,26 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+  eslint:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -21,4 +21,5 @@ tmp
 *.a
 mkmf.log
 .env
-*.sqlite
+*.sqlite
+test.db

data/.rubocop.yml

@@ -1,62 +1,121 @@
-Style/LineLength:
+AllCops:
+  TargetRubyVersion: 2.2
+
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/LineLength:
   Max: 120
 
-Style/AccessModifierIndentation:
-  EnforceStyle: indent
+Metrics/MethodLength:
+  Max: 15
 
-Style/IndentationConsistency:
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Style/Alias:
   Enabled: false
 
-Style/TrailingBlankLines:
+Style/CommentIndentation:
   Enabled: false
 
-Style/EmptyLinesAroundBody:
+Style/EmptyLines:
   Enabled: false
 
-Style/StringLiterals:
+Style/EmptyLinesAroundBlockBody:
   Enabled: false
 
-Style/SpaceInsideParens:
+Style/EmptyLinesAroundClassBody:
   Enabled: false
 
-Style/SpaceBeforeBlockBraces:
+Style/EmptyLinesAroundModuleBody:
   Enabled: false
 
-Style/SpaceInsideBlockBraces:
+Style/DoubleNegation:
   Enabled: false
 
-Style/SpaceInsideBrackets:
+Style/Documentation:
   Enabled: false
 
-Style/SingleLineBlockParams:
+Style/GuardClause:
   Enabled: false
 
-Style/SingleSpaceBeforeFirstArg:
+Style/HashSyntax:
   Enabled: false
 
-Style/TrailingComma:
+Style/IndentArray:
   Enabled: false
 
-Style/SpaceAfterComma:
+Style/IndentationConsistency:
   Enabled: false
 
-Style/ClassAndModuleChildren:
-  EnforcedStyle: nested
+Style/IndentationWidth:
+  Enabled: false
 
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%':  '{}'
-    '%i': '{}'
-    '%q': '{}'
-    '%Q': '{}'
-    '%r': '{}'
-    '%s': '{}'
-    '%w': '{}'
-    '%W': '{}'
-    '%x': '{}'
+Style/Lambda:
+  Enabled: false
 
-Lint/AssignmentInCondition:
+Style/MultilineBlockChain:
   Enabled: false
 
-Lint/AmbiguousRegexpLiteral:
+Style/OptionHash:
+ Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SpaceAroundBlockParameters:
+  Enabled: false
+
+Style/SpaceAroundOperators:
+  Enabled: false
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/SpaceInsideParens:
+  Enabled: false
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingBlankLines:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/UnneededInterpolation:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/WordArray:
   Enabled: false

data/.yardopts

@@ -1,7 +1,6 @@
---protected
---no-private
+--markup markdown
 --no-cache
+--no-private
+--hide-api internal
 --hide-void-return
---output-dir /tmp/shamu_docs
---db /tmp/shamu_yardoc
---markup markdown
+--plugin activesupport-concern

data/Gemfile

@@ -1,20 +1,32 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in shamu.gemspec
+# Specify your gem"s dependencies in shamu.gemspec
 gemspec
 
 group :test do
+  gem "activerecord", "~> 4.2.5"
+  gem "actionpack", "~> 4.2.5"
+  gem "kaminari", "~> 0.16.3", require: false
 
-  gem 'guard', '~> 2.12.8'
-  gem 'spring'
-  gem 'byebug'
-  gem 'pry-byebug'
-  gem 'guard-rspec'
-  gem 'fuubar'
-  gem 'yard'
-  gem 'simplecov', github: "colszowka/simplecov"
-  gem 'ruby_gntp', '~> 0.3.4'
-  gem 'awesome_print'
+  gem "byebug"
+  gem "pry-byebug"
+
+  gem "sqlite3", "~> 1.3.11"
+  gem "guard", "~> 2.12.8"
+  gem "rubocop"
+  gem "guard-rubocop"
+  gem "spring"
+  gem "guard-rspec"
+  gem "rspec-its"
+  gem "rspec-wait"
+  gem "rspec-rails", require: false
+  gem "fuubar"
+  gem "yard"
+  gem "yard-activesupport-concern"
+  gem "simplecov", github: "colszowka/simplecov"
+  gem "ruby_gntp", "~> 0.3.4"
+  gem "awesome_print"
 
   gem "codeclimate-test-reporter", group: :test, require: nil
+  gem "rspec_junit_formatter", "~> 0.2.2", platforms: :mri
 end

data/Guardfile

@@ -1,3 +1,8 @@
+guard :rubocop, all_on_start: false, cli: [ "--display-cop-names", "--display-style-guide" ] do
+  watch( /lib\/.*\.rb$/ )
+  watch( /spec\/.*\.rb$/ )
+end
+
 guard :rspec, cmd: "bundle exec rspec" do
   require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)

data/LABELS.md

@@ -0,0 +1,22 @@
+# Kind
+
+- __kind/bug__ the reported issue or PR addresses a bug.
+- __kind/design__ design work for a _kind/feature_.
+- __kind/eng__ general eng work. Part of a larger _kind/feature_.
+- __kind/feature__ a comprehensive 
+- __kind/task__ non-eng/design work such as updating blogs, registering accounts, etc.
+
+# Review
+
+- __review/ship-it__ - changes are approved. Merge to master.
+- __review/waiting-for-changes__ - the PR has been reviewed but changes are required. Remove label when changes have been submitted.
+- __review/work-in-progress__ - the PR is a work in progress open for comments understanding it is not ready for production.
+
+# Status
+
+- __status/blocked__ - cannot ship due to dependencies. Mention any open issues or PRs that are blocking.
+- __status/duplicate__ - duplicate of another issue or PR.
+- __status/hold__ - ready for production but don't deploy yet. 
+- __status/in-progress__ - work is currently being done on the issue.
+- __status/need-help__ - issue needs help from OSS community.
+- __status/wontfix__ - while the issue or PR may be valid we are choosing not to address it.

data/README.md

@@ -10,3 +10,44 @@ Have a whale of a good time adding Service Oriented Architecture to your ruby pr
 
 (Also check out [shog](http://github.com/phallguy/shog) for better rails logs)
 
+# SOA
+
+# Components
+
+- {Shamu::Attributes}
+- {Shamu::Entities}
+- {Shamu::Services}
+- {Shamu::Security}
+- {Shamu::Sessions}
+- {Shamu::Events}
+- {Shamu::Auditing}
+- {Shamu::Features}
+- {Shamu::Rails}
+
+
+
+# Dependency Injection
+
+....
+[Scorpion](http://github.com/phallguy/scorpion)
+
+# Using with Rails
+
+
+## Active Record
+
+Shamu does not come with a hard dependency on ActiveRecord - it should work with
+any persistence you've chosen to use in your project. It does come with some
+convenience mixins to make it easier to work with AR.
+
+
+- **{Shamu::Entities::ActiveRecord}** adds convenience methods for working with
+  ActiveRecord models as entities.
+
+## Controllers
+
+- {Shamu::Rails::Controller}
+
+# Contributing
+
+See [LABELS](LABELS.md)

data/Rakefile

@@ -1,2 +1,14 @@
 require "bundler/gem_tasks"
 
+desc "Run the specs"
+task :specs do
+  system "rspec"
+end
+
+desc "Run linters on the codebase"
+task :lint do
+  system "rubocop"
+end
+
+task :default => [ :lint, :specs ]
+task :release => [ :default ]

data/circle.yml

@@ -1,5 +1,9 @@
 database:
   override:
-    # We don't actually use a DB but it is included in the internal rails app
-    # for specs. So override default behavior to do nothing
-    - echo "Skip DB"
+    # We manually setup a sqlite3 database so don't setup anything on the CI machine
+    - echo "Skip DB"
+
+test:
+  override:
+    - RAILS_ENV=test bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+    - bundle exec rubocop

data/config.ru

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/shamu/active_record.rb

@@ -0,0 +1,7 @@
+require "shamu/entities/active_record"
+require "shamu/entities/active_record_soft_destroy"
+require "shamu/services/active_record"
+require "shamu/services/active_record_crud"
+require "shamu/security/active_record_policy"
+require "shamu/security/policy_refinement"
+require "shamu/events/active_record"

data/lib/shamu/attributes/assignment.rb

@@ -0,0 +1,114 @@
+require "active_support/concern"
+
+module Shamu
+  module Attributes
+
+    # Provide a means for defining writable attributes.
+    module Assignment
+      extend ActiveSupport::Concern
+
+      included do |base|
+        raise "Must include Shamu::Attributes first." unless base < Shamu::Attributes
+        public :assign_attributes
+      end
+
+      class_methods do
+
+        # Define a new attribute for the class.
+        #
+        # @param (see Projection::DSL#attribute)
+        # @param [Symbol, #call] coerce name of a method on the assigned value
+        #     to call, or a custom method that can parse values when assigning
+        #     the attribute.
+        # @param [Boolean] array true if the expected value should be an array.
+        #
+        # @return [void]
+        #
+        # @example
+        #
+        #   class Params
+        #     include Shamu::Attributes
+        #     include Shamu::Attributes::Assignment
+        #
+        #     attribute :created_at, coerce: :to_datetime
+        #     attribute :count, coerce: :to_i
+        #     attribute :label, coerce: ->(value){ value.upcase.to_sym }
+        #     attribute :tags, coerce: :to_s, array: true
+        #   end
+        def attribute( name, *args, **options, &block )
+          super
+          define_attribute_assignment( name, **options )
+          define_attribute_writer( name, **options )
+        end
+
+        private
+
+          def attribute_option_keys
+            super + [ :coerce, :array ]
+          end
+
+          def define_attribute_assignment( name, coerce: :smart, array: false, ** )
+            super
+
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def assign_#{ name }( *values )
+                @#{ name } = coerce_#{ name }#{ array ? '_array' : '' }( *values )
+              end
+            RUBY
+            private :"assign_#{ name }"
+
+            define_attribute_coercion( name, coerce )
+            define_attribute_array( name ) if array
+          end
+
+          def define_attribute_array( name )
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def coerce_#{ name }_array( value )
+                value && Array( value ).map do |v|
+                  coerce_#{ name }( v )
+                end
+              end
+            RUBY
+
+            private :"coerce_#{ name }_array"
+          end
+
+          def define_attribute_coercion( name, coerce )
+            coerce = cource_method( name, coerce )
+
+            if !coerce || coerce.is_a?( Symbol )
+              class_eval <<-RUBY, __FILE__, __LINE__ + 1
+                def coerce_#{ name }( value )
+                  value#{ coerce && ".#{ coerce }" }
+                end
+              RUBY
+            elsif coerce
+              define_method :"coerce_#{ name }", coerce
+            end
+
+            private :"coerce_#{ name }"
+          end
+
+          def cource_method( name, coerce )
+            if coerce == :smart
+              case name
+              when /_at$/, /_on$/ then :to_datetime
+              when /_ids?$/       then :to_i
+              end
+            else
+              coerce
+            end
+          end
+
+          def define_attribute_writer( name, as: nil, ** )
+            alias_method :"#{ name }=", :"assign_#{ name }"
+            public :"#{ name }="
+
+            alias_method :"#{ as }=", :"#{ name }=" if as
+          end
+
+      end
+
+    end
+  end
+end

data/lib/shamu/attributes/equality.rb

@@ -0,0 +1,40 @@
+module Shamu
+  module Attributes
+
+    # Override equality methods to support shallow comparison of attribute
+    # values for equality.
+    #
+    # Add `ignore_inequality: true` to any {Attributes::DSL#attribute} that
+    # shouldn't be included in equalty comparisons.
+    module Equality
+
+      # @param [Attributes] other object to compare with.
+      # @return [Boolean] true if the two objects are of the same type and
+      #     attributes are all eql? to each other.
+      def ==( other )
+        return false unless other.is_a?( self.class ) || is_a?( other.class )
+        attributes_eql?( other )
+      end
+      alias_method :eql?, :==
+
+      # @return [Integer] a hash computed from the attributes of the object.
+      def hash
+        self.class.attributes.map do |key, _|
+          send( key )
+        end.hash
+      end
+
+      private
+
+        # @return [Boolean] true if the object's attributes and `other`
+        #     attributes are all `eql?` to each other.
+        def attributes_eql?( other )
+          self.class.attributes.all? do |key, attr|
+            next true if attr[:ignore_inequality]
+            send( key ).eql?( other.send( key ) )
+          end
+        end
+
+    end
+  end
+end

data/lib/shamu/attributes/fluid_assignment.rb

@@ -0,0 +1,49 @@
+module Shamu
+  module Attributes
+
+    # Add  methods to a class to make it easy to build out an object using fluid
+    # assignment.
+    #
+    # @example
+    #
+    #   # Without fluid
+    #   obj = AttributeObject.new
+    #   obj.name = '...'
+    #   obj.email = '...'
+    #
+    #   # With fluid
+    #   obj = FluidObject.new
+    #   obj.name( '...' )
+    #      .email( '...' )
+    module FluidAssignment
+      extend ActiveSupport::Concern
+
+      included do |base|
+        raise "Must include Shamu::Attributes first." unless base < Shamu::Attributes
+        raise "Must include Shamu::Attributes::Assignment first." unless base < Shamu::Attributes::Assignment
+      end
+
+      # DSL for declaring fluid assignment.
+      class_methods do
+
+        private
+
+          def define_attribute_reader( name, ** )
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{ name }( *args )
+                if args.length > 0
+                  assign_#{ name }( *args )
+                  self
+                else
+                  return @#{ name } if defined? @#{ name }
+                  @#{ name } = fetch_#{ name }
+                end
+              end
+            RUBY
+          end
+
+      end
+
+    end
+  end
+end

data/lib/shamu/attributes/validation.rb

@@ -0,0 +1,74 @@
+require "active_model"
+
+module Shamu
+  module Attributes
+
+    # Defines an interface for entities that report validation failures with
+    # respect to their attributes.
+    module Validation
+      extend ActiveSupport::Concern
+
+      included do |base|
+        raise "Must include Shamu::Attributes first." unless base < Shamu::Attributes
+
+        base.include( ::ActiveModel::Validations )
+        base.include( Validation::Overrides )
+      end
+
+      # @return [Boolean] if the object is free from validation errors. Must
+      #   call {#validate} before checking.
+      def valid?
+        errors.blank?
+      end
+
+      # @return [Boolean] true if the object has been validated at least once.
+      def validated?
+        @validated
+      end
+
+      class_methods do
+
+        # Adds validation options to {Attributes::DSL#attribute}. Any option not
+        # recognized by one of the Attributes mixins will be used as validation
+        # arguments for the given attribute.
+        #
+        # @overload attribute( name, build, **options )
+        # @param (see Attributes::Assignment::DSL#attribute)
+        # @return (see Attributes::Assignment::DSL#attribute)
+        #
+        # @example
+        #   attribute :email, presence: true
+        #
+        #   # Results in
+        #   attribute :email
+        #   validates :email, presence: true
+        def attribute( name, *args, **options, &block )
+          super
+
+          validation_options = options.each_with_object({}) do |(key, value), opts|
+            opts[key] = value unless attribute_option_keys.include?( key )
+          end
+          validates name, validation_options if validation_options.any?
+        end
+      end
+
+      # Overrides ActiveModel::Validation behavior to match Shamu validation
+      # behaviors.
+      module Overrides
+        # @return [Boolean] true if there are no errors reported manually or
+        #     through {Validation#validate}.
+        def valid?
+          validate unless validated?
+          errors.empty?
+        end
+
+        # Validate the attributes and expose any errors via {#errors}.
+        def validate
+          @validated = true
+          run_validations!
+        end
+      end
+
+    end
+  end
+end