corvette 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cee5ee9bcae209772e61cdb2c97c0bc15ff6b363
+  data.tar.gz: 0c78a900f9a0de81c60e34ad6f36abcac687fbe3
+SHA512:
+  metadata.gz: 36c59701ffc4689b5097338bf5aace9a7ed2f7bf46a93ad3904fdd740a9c43c5f84ce6c856870c091329c5540f714e68267f7209e250e40ad27fb328c5b162d9
+  data.tar.gz: 0ba8a5a7259ae2da55493faa12089e4ede7761b56bd31cfc19fbf39a2cea97630062e4590497a103e8a3a3f419c924fd4a5f77215d3d61702809b0b13c1679f3

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in corvette.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 BroderickBrockman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Corvette
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'corvette'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install corvette
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/corvette/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/corvette.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'corvette/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'corvette'
+	spec.version = Corvette::VERSION
+	spec.authors = ['BroderickBrockman']
+	spec.email = ['broderickbrockman@gmail.com']
+	spec.summary = %q{Kind of new rails architecture solution}
+	spec.description = %q{Some kind of new rails architecture solution}
+	spec.homepage = 'http://corvette-gem.com'
+	spec.license = 'MIT'
+
+	spec.files = `git ls-files -z`.split("\x0")
+	spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler', '~> 1.6'
+	spec.add_development_dependency 'rake', '~> 0'
+	spec.add_runtime_dependency 'reform', '1.1.1'
+	spec.add_runtime_dependency 'hashie', '3.3.1'
+	spec.add_runtime_dependency 'activesupport', '4.1.5'
+	spec.add_runtime_dependency 'virtus', '1.0.3'
+end

data/lib/corvette/act.rb

@@ -0,0 +1,122 @@
+require 'corvette/assertion'
+module Corvette
+	class Act
+		class ActError < StandardError
+			attr_accessor :act
+		end
+
+		include Assertion
+		# include ActiveSupport::Rescuable
+		# rescue_from ERRORS, with: :log_error
+
+		def initialize(options={})
+			@options = options
+			process_callbacks
+		end
+
+		def run
+			raise NotImplementedError, 'must be overridden'
+		end
+
+		def process_params(params)
+			assert { params.is_a?(Hash) }
+
+			if params.is_a?(Hashie::Mash)
+				@params = params
+			else
+				@params = Hashie::Mash.new(params)
+			end
+		end
+
+		def process_callbacks
+			@error_callback = @options[:on_error]
+			@success_callback = @options[:on_success]
+		end
+
+		def act_success
+			@success_callback.call(self) if @success_callback.is_a?(Proc)
+		end
+
+		def act_error(exception)
+			@error_callback.call(self, exception) if @error_callback.is_a?(Proc)
+		end
+
+		def log_error(exception, params = nil)
+			message = "message: #{ exception.message }; place: #{act_name}; (#{ exception.class })"
+
+			case exception
+			when Validation::ValidationError, Required::RequiredError
+				message << " error: #{exception.errors.inspect};"
+			else
+				#nothing
+			end
+
+			unless params.nil?
+				message << " params: #{params.inspect}"
+			end
+
+			Rails.logger.error message
+		end
+
+		def logger
+			Rails.logger
+		end
+
+		def act_name
+			@act_name ||= self.class.name.to_s
+		end
+
+		module Auxiliary
+			def process_auxiliary
+				if @options[:auxiliary]
+					@auxiliary = Hashie::Mash.new(@options[:auxiliary])
+				else
+					@auxiliary = Hashie::Mash.new
+				end
+				singleton_class.class_eval do
+					attr_reader :auxiliary
+				end
+			end
+		end
+
+		module Required
+			class RequiredError < StandardError
+				attr_accessor :errors
+			end
+
+			def process_required
+				if self.class.const_defined?(:RequiredContract)
+					@required = Hashie::Mash.new(@options[:required]||{})
+					required_contract = required_contract_class.new(@required)
+					unless required_contract.validate
+						exception = RequiredError.new
+						exception.errors = required_contract.errors.messages
+						raise exception
+					end
+					singleton_class.class_eval do
+						attr_reader :required
+					end
+				end
+			rescue StandardError => exception
+				# rescue_with_handler(exception) || raise
+				log_error(exception)
+				act_error(exception)
+			end
+
+			def required_contract_class
+				self.class.const_get :RequiredContract
+			end
+		end
+
+		module Validation
+			class ValidationError < StandardError
+				attr_accessor :errors
+			end
+
+			def contract_klass
+				self.class.const_get :Contract
+			end
+		end
+	end
+end
+# rescue_with_handler(exception) || raise

data/lib/corvette/action.rb

@@ -0,0 +1,18 @@
+require 'corvette/assertion'
+require 'corvette/act'
+
+module Corvette
+	class Action < Act
+		include Auxiliary
+		include Required
+
+		def action(params)
+			process_params(params)
+			yield
+			act_success
+		rescue StandardError => exception
+			log_error(exception, params)
+			act_error(exception)
+		end
+	end
+end

data/lib/corvette/assertion.rb

@@ -0,0 +1,7 @@
+module Corvette
+	module Assertion
+		def assert &block
+			raise ArgumentError unless block.call()
+		end
+	end
+end

data/lib/corvette/operation.rb

@@ -0,0 +1,54 @@
+# require 'corvette/operation/model'
+# require 'corvette/operation/multiple_models'
+# require 'corvette/operation/anonymous_model'
+# require 'corvette/operation/background_job'
+# require 'corvette/operation/active_record_model'
+
+require 'corvette/assertion'
+require 'corvette/act'
+
+module Corvette
+	class Operation < Act
+		include Validation
+		extend Forwardable
+
+		delegate [:model, :errors] => :contract
+
+		attr_reader :contract
+
+		def operation(model, params)
+			operation_log(:start)
+			process_params(params)
+			operation_validate(model, params)
+			yield
+			act_success
+			operation_log(:end)
+		rescue StandardError => exception
+			log_error(exception, params)
+			act_error(exception)
+		end
+
+		private
+
+		def operation_validate(model, params)
+			@contract = contract_klass.new(model)
+			unless contract.validate(params)
+				exception = ValidationError.new("validation failed")
+				exception.errors = contract.errors.messages
+				raise exception
+			end
+			operation_log(:validation_success)
+		end
+
+		def operation_log(kind)
+			case kind
+			when :start
+				logger.info "operation started (#{act_name})"
+			when :end
+				logger.info "operation ended (#{act_name})"
+			when :validation_success
+				logger.info "params validation succeeded (#{act_name})"
+			end
+		end
+	end
+end

data/lib/corvette/procedure.rb

@@ -0,0 +1,49 @@
+require 'corvette/assertion'
+require 'corvette/act'
+module Corvette
+	class Procedure < Act
+
+		include Validation
+		include Auxiliary
+		include Required
+
+		def procedure(params)
+			procedure_log(:start)
+			process_params(params)
+			process_auxiliary
+			process_required
+			procedure_validate(params)
+			yield
+			act_success
+			procedure_log(:end)
+		rescue StandardError => exception
+			log_error(exception, params)
+			act_error(exception)
+		end
+
+		private
+
+		def procedure_validate(params)
+			model = OpenStruct.new
+			contract = contract_klass.new(model)
+
+			unless contract.validate(params)
+				exception = ValidationError.new("validation failed")
+				exception.errors = contract.errors.messages
+				raise exception
+			end
+			procedure_log(:validation_success)
+		end
+
+		def procedure_log(kind)
+			case kind
+			when :start
+				logger.info "procedure started (#{act_name})"
+			when :end
+				logger.info "procedure ended (#{act_name})"
+			when :validation_success
+				logger.info "params validation succeeded (#{act_name})"
+			end
+		end
+	end
+end

data/lib/corvette/railtie.rb

@@ -0,0 +1,13 @@
+module Corvette
+	class Railtie < ::Rails::Railtie
+		initializer 'corvette.basic', :after => :add_routing_paths do |app|
+			module StringGenerator
+				def generate_string(length)
+					o = [('a'..'z'), ('A'..'Z'), (0..9)].map { |i| i.to_a }.flatten
+					(0..length).map { o[rand(o.length)] }.join
+				end
+			end
+			Object.include(StringGenerator)
+		end
+	end
+end

data/lib/corvette/service.rb

@@ -0,0 +1,6 @@
+module Corvette
+	class Service
+		include Assertion
+		include Virtus.model
+	end
+end

data/lib/corvette/version.rb

@@ -0,0 +1,3 @@
+module Corvette
+  VERSION = "0.0.2"
+end

data/lib/corvette.rb

@@ -0,0 +1,16 @@
+module Corvette
+	module Helper
+		def corvette_concept(name)
+			"#{name}_concept".camelcase.constantize
+		end
+	end
+end
+
+require "corvette/version"
+require "corvette/railtie"
+require "corvette/operation"
+require "corvette/procedure"
+require "corvette/action"
+require "corvette/service"
+require "corvette/assertion"
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: corvette
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- BroderickBrockman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: reform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.5
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: Some kind of new rails architecture solution
+email:
+- broderickbrockman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- corvette.gemspec
+- lib/corvette.rb
+- lib/corvette/act.rb
+- lib/corvette/action.rb
+- lib/corvette/assertion.rb
+- lib/corvette/operation.rb
+- lib/corvette/procedure.rb
+- lib/corvette/railtie.rb
+- lib/corvette/service.rb
+- lib/corvette/version.rb
+homepage: http://corvette-gem.com
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Kind of new rails architecture solution
+test_files: []