hexx-entities 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cfb1586f444fcffc282f8875fc0f158e93e190e
+  data.tar.gz: b7ed4909ae9aeb7cd0e91969d418e852dd80f063
+SHA512:
+  metadata.gz: f4b9a371d643448b7a762f2797a1666ad10401d2f006de90250000fe869b03d28475c86b26d67bed7785a959e6ae65cf04cad84e090e785c42d1b434a7cfaeda
+  data.tar.gz: d4b415a67d586bd3fa957db482344a04b6713ac5e20d918c77864ff64c4b10445d68595be294fc3d1f18dfe02c628e6c2ba8aaf49eb5ffe7d56fb05d677ed4e5

data/.coveralls.yml

@@ -0,0 +1,2 @@
+---
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.lock
+.bundle/
+.yardoc/
+coverage/
+doc/
+log/
+pkg/
+tmp/

data/.metrics

@@ -0,0 +1,9 @@
+# Settings for metric_fu and its packages are collected in the `config/metrics`
+# and loaded by the Hexx::Suit::Metrics::MetricFu.
+
+begin
+  require "hexx-suit"
+  Hexx::Suit::Metrics::MetricFu.load
+rescue LoadError
+  puts "The 'hexx-suit' gem is not installed"
+end

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+---
+inherit_from: "./config/metrics/rubocop.yml"

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language:     ruby
+bundler_args: --without metrics
+cache:        bundler
+script:       rake test:coverage:run
+rvm:
+  - '2.1'
+  - '2.2'
+  - ruby-head

data/.yardopts

@@ -0,0 +1,3 @@
+--asset LICENSE
+--exclude lib/hexx-entities/version.rb
+--output doc/api

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "hexx-suit", "~> 2.2", group: :metrics if RUBY_ENGINE == "ruby"

data/Guardfile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+guard :rspec, cmd: "bundle exec rspec" do
+
+  watch(%r{^spec/tests/.+_spec\.rb$})
+
+  watch(%r{^lib/hexx/entities/(.+)\.rb}) do |m|
+    "spec/tests/#{ m[1] }_spec.rb"
+  end
+
+  watch(%r{^lib/\w+\.rb$})     { "spec" }
+  watch("spec/spec_helper.rb") { "spec" }
+
+end # guard :rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2015 Andrew Kozin (nepalez), andrew.kozin@gmail.com
+
+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,268 @@
+Hexx::Entities
+==============
+
+[![Gem Version](https://img.shields.io/gem/v/hexx-entities.svg?style=flat)][gem]
+[![Build Status](https://img.shields.io/travis/nepalez/hexx-entities/master.svg?style=flat)][travis]
+[![Dependency Status](https://img.shields.io/gemnasium/nepalez/hexx-entities.svg?style=flat)][gemnasium]
+[![Code Climate](https://img.shields.io/codeclimate/github/nepalez/hexx-entities.svg?style=flat)][codeclimate]
+[![Coverage](https://img.shields.io/coveralls/nepalez/hexx-entities.svg?style=flat)][coveralls]
+[![Inline docs](http://inch-ci.org/github/nepalez/hexx-entities.svg)][inch]
+[![Documentation Status](https://readthedocs.org/projects/hexx-entities/badge/?version=latest)][readthedocs]
+
+[codeclimate]: https://codeclimate.com/github/nepalez/hexx-entities
+[coveralls]: https://coveralls.io/r/nepalez/hexx-entities
+[gem]: https://rubygems.org/gems/hexx-entities
+[gemnasium]: https://gemnasium.com/nepalez/hexx-entities
+[inch]: https://inch-ci.org/github/nepalez/hexx-entities
+[readthedocs]: https://hexx-entities.readthedocs.org
+[travis]: https://travis-ci.org/nepalez/hexx-entities
+
+Base class for domain entities:
+
+* [synopsis](#synopsis)
+* [istallation](#istallation)
+* [usage](#usage)
+* [compatibility](#compatibility)
+* [contributing](#contributing)
+* [license](#license)
+
+Check the documentation at [Read the Docs]
+
+Synopsis
+--------
+
+The [entity] describes (immutable) domain objects that have identity.
+
+When descibing an entity you are expected to declare its attributes and
+validations in the following way:
+
+```ruby
+require "hexx-entities"
+
+class Item < Hexx::Entities::Base
+
+  # Defines attributes with their coercers
+  attribute :foo, coerce: ->(value) { value.to_s }
+  attribute :bar
+
+  # Defines validation for the entity
+  validate { invalid :blank_foo unless foo }
+  validate { invalid :blank_bar unless bar }
+
+end # class Item
+
+item = Item.new foo: 1
+item.attributes
+# => { uuids: ["31a840f4-71e2-4de1-3a6f-04d2103aa2e8"], foo: "1", bar: nil }
+item.validate!
+# <Attestor::InvalidError> because bar is nil
+```
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem "hexx-entities"
+```
+
+Then execute:
+
+```
+bundle
+```
+
+Or add it manually:
+
+```
+gem install hexx-entities
+```
+
+Usage
+-----
+
+* [entity declaration](#declaration)
+* [identity and equality](#identity-and-equality)
+* [attributes and their initializer](#attributes-and-their-initializer)
+* [validation](#validation)
+* [serialization](#serialization)
+
+### Entity Declaration
+
+Define the entity as a subclass of `Hexx::Entities::Base`:
+
+```ruby
+class Item < Hexx::Entities::Base
+end
+```
+
+### Identity and Equality
+
+An entity is identified by its [uuids]. Uuids are either initialized,
+or assigned by default:
+
+[uuid]: https://en.wikipedia.org/wiki/Universally_unique_identifier
+
+```ruby
+entity = Item.new
+entity.uuids # => ["31a840f4-71e2-4de1-3a6f-04d2103aa2e8"]
+```
+
+The entity is equal to any entity that responds to `uuids` and 
+has at least one uuid, that is equal to its own:
+
+```ruby
+a = Item.new uuids: [
+  "31a840f4-71e2-4de1-3a6f-04d2103aa2e8", # this value...
+  "78340523-8928-1ab0-0a3f-fa9eb07a7986"
+]
+
+b = Hexx::Entities::Base.new uuids: [
+  "9875023e-f483-cef9-ae09-27384015de79",
+  "31a840f4-71e2-4de1-3a6f-04d2103aa2e8"  # ...is equal to this one
+]
+
+a == b # => true
+```
+
+Any uuid in the list is an instance of `Hexx::Entities::UUID` (kind of string).
+The instance is validatable:
+
+```ruby
+uuid = Hexx::Entities::UUID.new "9875023e-f483-cef9-ae09-27384015de79"
+# => "9875023e-f483-cef9-ae09-27384015de79"
+uuid.validate! # passes
+
+uuid = Hexx::Entities::UUID.new "not a valid uuid"
+# => "not a valid uuid"
+uuid.validate! # <Attestor::InvalidError>
+```
+
+### Attributes and their Initializer
+
+The gem uses the [eigindir] library for attributes definition and coersion.
+The `uuids` attribute is added by default.
+
+All attributes can be initialized from hash:
+
+```ruby
+class Foo < Hexx::Entities::Base
+
+  attribute :bar
+  attribute :baz, coerce: ->(value) { value.to_s }
+
+end
+
+foo = Foo.new bar: :bar, "baz" => :baz
+foo.attributes
+# => { uuids: ["9875023e-f483-cef9-ae09-27384015de79"], bar: :bar, baz: "baz" }
+```
+
+[eigindir]: https://github.com/nepalez/eigindir
+
+### Validation
+
+The gem uses the [attestor] library for validation. Any entity is
+a validatable object and responds to `#validate` and `#validate!` instance
+methods.
+
+Validation rules should be defined on class level with `.validate` helper,
+or with the help of externam policy objects by `.validates` (with s) method:
+
+```ruby
+class Foo < Hexx::Entities::Base
+
+  attribute :bar
+  attribute :baz, coerce: ->(value) { Baz.new value }
+
+  validate { invalid :blank_bar unless bar }
+  # providing Baz responds to #validate! delegates validations:
+  validates :baz
+
+end
+```
+
+Any enitiy is invalid when any of its uuids is invalid:
+
+```ruby
+Foo = Class.new Hexx::Entities::Base
+foo = Foo.new uuids: ["invalid uuid"]
+foo.validate! # <Attestor::InvalidError>
+```
+
+This is the only validation rule that is added to entity by default.
+
+### Serialization
+
+Entities can be converted to nested hash by the `serialize` method.
+Any attribute is serialized recursively if it responds to `serialize` without
+arguments:
+
+```ruby
+class Foo < Hexx::Entities::Base
+
+  attribute :bar, coerce: ->(value) { value.to_f }
+  attribute :baz, coerce: ->(value) { value.to_s }
+
+end
+
+class Qux < Hexx::Entities::Base
+
+  attribute :foo, coerce: ->(value) { Foo.new value }
+  attribute :qux
+
+end
+
+foo = Foo.new bar: 1, baz: 1
+qux = Qux.new foo: foo
+
+qux.serialize
+# {
+#   uuids: ["78340523-8928-1ab0-0a3f-fa9eb07a7986"],
+#   foo:   {
+#     uuids: ["31a840f4-71e2-4de1-3a6f-04d2103aa2e8"],
+#     bar:   1.0,
+#     baz:   "1"
+#   }
+# }
+```
+
+**Notice** the method is not protected against looping. In cases the later is
+possible, you'd better to redefine the `serialize` method by itself with
+custom protection.
+
+Compatibility
+-------------
+
+Tested under [MRI rubies 2.1+](.travis.yml).
+The module heavily uses [refinements], not yet supported by Rubinius and JRuby.
+
+Backed on libraries:
+* [eigindir] for defining attributes
+* [attestor] for validations
+
+Uses [RSpec] 3.0+ for testing and [hexx-suit] for dev/test tools collection.
+
+[refinements]: http://ruby-doc.org/core-2.1.1/doc/syntax/refinements_rdoc.html
+[attestor]:    http://github.com/nepalez/attestor
+[eigindir]:    http://github.com/nepalez/eigindir
+[RSpec]:       http://rspec.org
+[hexx-suit]:   https://github.com/nepalez/hexx-suit
+
+Contributing
+------------
+
+* Read the [STYLEGUIDE](config/metrics/STYLEGUIDE)
+* [Fork the project](https://github.com/nepalez/hexx-entities)
+* Create your feature branch (`git checkout -b my-new-feature`)
+* Add tests for it
+* Commit your changes (`git commit -am '[UPDATE] Add some feature'`)
+* Push to the branch (`git push origin my-new-feature`)
+* Create a new Pull Request
+
+License
+-------
+
+See the [MIT LICENSE](LICENSE).

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: utf-8
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+  exit
+end
+
+# Loads bundler tasks
+Bundler::GemHelper.install_tasks
+
+# Loads the Hexx::RSpec and its tasks
+begin
+  require "hexx-suit"
+  Hexx::Suit.install_tasks
+rescue LoadError
+  require "hexx-rspec"
+  Hexx::RSpec.install_tasks
+end
+
+# Sets the Hexx::RSpec :test task to default
+task default: "test:coverage:run"

data/config/metrics/STYLEGUIDE

@@ -0,0 +1,230 @@
+= Ruby Style Guide
+
+Adapted from Dan Kubb's Ruby Style Guide
+https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
+
+== Commiting:
+
+* Write descriptive commit messages, following the pattern:
+
+    [TYPE] name
+
+    The message, describing the changes being made
+
+* Use the types below to mark commits:
+
+  - FEATURE - for adding new features, or backward-compatible changes;
+  - CHANGE - for backward-incompatible changes;
+  - BUG FIX - for fixing bugs;
+  - REFACTORING - for other changes of the code not affecting the API;
+  - OTHER - for changes in documentaton, metrics etc, not touching the code;
+  - VERSION - for version changes.
+
+* Always separate commits of different types (such as FEATURE and CHANGE).
+
+* Try to separate various features from each other.
+
+* Include specification to the same commit as the code.
+
+* Run all tests before making a commit.
+  Never commit the code that break unit tests.
+
+* Use metric (run `rake check`) before making a commit.
+
+* Do refactoring before making a commit. Best writing is rewriting.
+
+* Follow semantic versioning.
+
+    http://semver.org/
+
+* For versions name the commit after a version number, following the pattern:
+
+    VERSION 1.0.0-rc2
+
+
+== Formatting:
+
+* Use UTF-8. Declare encoding in the first line of every file.
+
+    # encoding: utf-8
+
+* Use 2 space indent, no tabs.
+
+* Use Unix-style line endings.
+
+* Use spaces around operators, after commas, colons and semicolons,
+  around { and before }.
+
+* No spaces after (, [ and before ], ).
+
+* Align `when` and `else` with `case`.
+
+* Use an empty line before the return value of a method (unless it
+  only has one line), and an empty line between defs.
+
+* Use empty lines to break up a long method into logical paragraphs.
+
+* Keep lines fewer than 80 characters.
+
+* Strip trailing whitespace.
+
+
+== Syntax:
+
+* Write for 2.0.
+
+* Use double quotes
+  
+    http://viget.com/extend/just-use-double-quoted-ruby-strings
+
+* Use def with parentheses when there are arguments.
+
+* Never use for, unless you exactly know why.
+
+* Never use then, except in case statements.
+
+* Use when x then ... for one-line cases.
+
+* Use &&/|| for boolean expressions, and/or for control flow. (Rule
+  of thumb: If you have to use outer parentheses, you are using the
+  wrong operators.)
+
+* Avoid double negation (!!), unless Null Objects are expected.
+  
+    http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness
+
+* Avoid multiline ?:, use if.
+
+* Use {...} when defining blocks on one line. Use do...end for multiline
+  blocks.
+
+* Avoid return where not required.
+
+* Use ||= freely.
+
+* Use OO regexps, and avoid =~ $0-9, $~, $` and $' when possible.
+
+* Do not use Enumerable#inject when the "memo" object does not change between
+  iterations, use Enumerable#each_with_object instead (in ruby 1.9,
+  active_support and backports).
+
+* Prefer ENV.fetch to ENV[] syntax.
+  Prefer block syntax for ENV.fetch to usage of the second argument.
+
+
+== Naming:
+
+* Use snake_case for methods.
+
+* Use CamelCase for classes and modules. (Keep acronyms like HTTP,
+  RFC, XML uppercase.)
+
+* Use SCREAMING_SNAKE_CASE for other constants.
+
+* Do not use single letter variable names. Avoid uncommunicative names.
+
+* Use consistent variable names. Try to keep the variable names close
+  to the object class name.
+
+* Use names prefixed with _ for unused variables.
+
+* When defining a predicate method that compares against another object of
+  a similar type, name the argument "other".
+
+* Prefer map over collect, detect over find, select over find_all.
+
+* Use def self.method to define singleton methods.
+
+* Avoid alias when alias_method will do.
+
+
+== Comments:
+
+* Use YARD and its conventions for API documentation. Don't put an
+  empty line between the comment block and the def.
+
+* Comments longer than a word are capitalized and use punctuation.
+  Use one space after periods.
+
+* Avoid superfluous comments.
+
+
+== Code structuring:
+
+* Break code into packages, decoupled from the environment.
+
+* Wrap packages into gems.
+
+* Inject dependencies explicitly.
+  Leave all outer references on the border of any package. Inside
+  the package use internal references only.
+
+* Follow SOLID principles.
+
+    http://en.wikipedia.org/wiki/SOLID_(object-oriented_design)
+
+* Only give a method one purpose for existing. If you pass in a boolean
+  to a method, what you're saying is that this method has two different
+  behaviours. Just split it into two single purpose methods. If you have
+  to use the words "AND" or "OR" to describe what the method does it
+  probably does too much.
+
+* Avoid long methods.
+  Try to keep them at no more than 6 lines long, and preferably 4 or less.
+
+  If sections of a method are logically separate by blank lines, then
+  that's probably a sign that those sections should be split into separate
+  methods.
+
+* Avoid hashes-as-optional-parameters. Does the method do too much?
+
+* Avoid long parameter lists.
+
+* Add "global" methods to Kernel (if you have to) and make them private.
+
+* Use OptionParser for parsing complex command line options and
+  ruby -s for trivial command line options.
+
+* Avoid needless metaprogramming.
+
+* Always freeze objects assigned to constants.
+
+
+== General:
+
+* Code in a functional way, avoid mutation when it makes sense.
+
+* Try to have methods either return the state of the object and have
+  no side effects, or return self and have side effects. This is
+  otherwise known as Command-query separation (CQS):
+
+    http://en.wikipedia.org/wiki/Command-query_separation
+
+* Do not mutate arguments unless that is the purpose of the method.
+
+* Try following TRUE heuristics by Sandi Metz
+
+    http://designisrefactoring.com/2015/02/08/introducing-sandi-metz-true/
+
+* Do not mess around in core classes when writing libraries.
+  Namespace your code inside the modules, or wrap core classes to
+  decorators of your own.
+
+* Do not program defensively.
+  
+    http://www.erlang.se/doc/programming_rules.shtml#HDR11
+
+* Keep the code simple.
+
+* Don't overdesign.
+
+* Don't underdesign.
+
+* Avoid bugs.
+
+* Read other style guides and apply the parts that don't dissent with
+  this list.
+
+* Be consistent.
+
+* Use common sense.

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

@@ -0,0 +1,2 @@
+---
+minimum_score: 5

data/config/metrics/metric_fu.yml

@@ -0,0 +1,15 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+- app
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/reek.yml

@@ -0,0 +1 @@
+---

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 300
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 4
+CyclomaticComplexityMethodCheck:
+  complexity: 8
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 20
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 300
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 5