hexx 7.1.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b0ca93b80a2f6c0c3748f0a273d9edda36972ba
-  data.tar.gz: 19527f2b06838db356f0bb99df053671bc1fce70
+  metadata.gz: 8d625ece05916e9121d6f01b3303115353579035
+  data.tar.gz: 8b8c07916d45bf1d6078651ef0a332a6342266fe
 SHA512:
-  metadata.gz: 74c24d5eed54e869db7b3fdcbfe9cfbe3b3e1f8fa11cb287c2c51b9c9cc568ec7b067894526b2d68de238c78d94398fbf4d080a6ccd3e5b6c31bdc31b49ea945
-  data.tar.gz: d66c7f7a5eb5dbc20b2b1fdf78c53fdbaa99c36290267fddf1941cc7634af2dd5a072650d2546d78c9dc7b34004215c05fd3755fdfd293bc02bad7afe6fb69d3
+  metadata.gz: 4978c9fc8738e710b4009737c890a0d6196e703f9a4aae9d2e8035bf7803bc4e7b98783e4d2a09f962886d1724e185f84b7aaf80556e75736a30bac9459a2d4e
+  data.tar.gz: b86403c6865eb3cb4b0ddd28fd9b8ca3afcff359fcb506fac7f54301b5c76a517cc795a3260c7e0bd4542b0ff38c3e6f757da3939da858745b67c3c08294ca5c

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,5 @@
+# Settings for metric_fu and its packages are collected in the `config/metrics`
+# and loaded by the Hexx::Suit::Metrics::MetricFu.
+
+require "hexx-suit"
+Hexx::Suit::Metrics::MetricFu.load

data/.rspec

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

data/.rubocop.yml

@@ -1,63 +1,2 @@
-Lint/HandleExceptions:
-  Exclude:
-    - 'spec/**/*'
-
-Lint/RescueException:
-  Exclude:
-    - 'spec/**/*'
-
-Metrics/ClassLength:
-  Exclude:
-    - 'lib/generators/**/*.rb'
-
-Style/AccessorMethodName:
-  Exclude:
-    - 'spec/**/*'
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'spec/**/*'
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-
-Style/EmptyLinesAroundBlockBody:
-  Enabled: false
-
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-
-Style/EmptyLinesAroundMethodBody:
-  Enabled: false
-
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-
-Style/EmptyLineBetweenDefs:
-  Enabled: false
-
-Style/RaiseArgs:
-  EnforcedStyle: compact
-
-Style/SingleLineMethods:
-  Exclude:
-    - 'spec/**/*'
-
-Style/SpecialGlobalVars:
-  Exclude:
-    - 'Gemfile'
-    - '*.gemspec'
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Stype/SingleSpaceBeforeFirstArg:
-  Enabled: false
-
-Style/TrivialAccessors:
-  Exclude:
-    - 'spec/**/*'
+---
+inherit_from: "./config/metrics/rubocop.yml"

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+rvm:
+  - '2.1'
+  - '2.2'

data/.yardopts

@@ -0,0 +1,2 @@
+--asset LICENSE
+--out doc/api

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

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

data/{LICENSE.rdoc → LICENSE}

@@ -1,6 +1,6 @@
-= The MIT License
+The MIT License
 
-Copyright (c) 2014 Andrew Kozin, https://github.com/nepalez
+Copyright (c) 2015 Andrew Kozin, 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

data/README.md

@@ -0,0 +1,138 @@
+# Hexx
+
+[![Gem Version](https://img.shields.io/gem/v/hexx.svg?style=flat)][gem]
+[![Build Status](https://img.shields.io/travis/nepalez/hexx/master.svg?style=flat)][travis]
+[![Dependency Status](https://img.shields.io/gemnasium/nepalez/hexx.svg?style=flat)][gemnasium]
+[![Code Climate](https://img.shields.io/codeclimate/github/nepalez/hexx.svg?style=flat)][codeclimate]
+[![Coverage](https://img.shields.io/coveralls/nepalez/hexx.svg?style=flat)][coveralls]
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)][MIT LICENSE]
+
+[MIT LICENSE]: file:./LICENSE
+[codeclimate]: https://codeclimate.com/github/nepalez/hexx
+[coveralls]: https://coveralls.io/r/nepalez/hexx
+[gem]: https://rubygems.org/gems/hexx
+[gemnasium]: https://gemnasium.com/nepalez/hexx
+[travis]: https://travis-ci.org/nepalez/hexx
+
+Collection of scaffolders for projects, that follows the [Hexagonal Architecture].
+
+[Hexagonal Architecture]: http://alistair.cockburn.us/Hexagonal+architecture
+
+## Introduction
+
+**The collection is neither a framework, nor library by itself**. I widely use external libraries, such as [activemodel], [virtus], [rom-rb], [wisper], [service_objects] etc.
+
+The **goal of the gem** is not to add new features but fix their usage as personal reusable standards of coding and testing applications.
+
+I structure applications by types of objects such as entities, services, validators, parsers etc. - exactly in the same way as accepted in [Rails]. When faced to new type of objects, I immediately create a new scaffolder and play with it for some time - until it becomes a standard I will follow afterwards.
+
+To apply [TDD] scaffolders generate specifications in [RSpec]. Both the specification and code are commented - they should be reviewed and uncommented after creation. Scaffolders follow [Yard] style when generate documentation.
+
+You're welcome to propose your own best (or even better) practices to be shared standards.
+
+[IoC container]: http://www.martinfowler.com/articles/injection.html#FormsOfDependencyInjection
+[RSpec]: http://rspec.info
+[Rails]: http://rubyonrails.org
+[TDD]: https://en.wikipedia.org/wiki/Test-driven_development
+[Yard]: http://yardoc.org
+[activemodel]: https://rubygems.org/gems/activemodel
+[rom-rb]: http://rom-rb.org
+[service_objects]: https://github.com/nepalez/service_objects
+[virtus]: https://github.com/solnic/virtus
+[wisper]: https://github.com/krisleech/wisper
+
+## Content
+
+The core module defines:
+
+* `Hexx::Generator` - The base class for the scaffolders, that inherits `Thor::Group` and extends it with additional methods.
+* `Hexx::Name` - The commonly used parser that takes a string and decorates it with methods, returning conventional names (for class, method, gemname, file, path etc.).
+* `$ hexx` - The CLI command to run scaffolders, defined in submodules (see below).
+
+All the specific scaffolders are created in their own submodules:
+
+* [hexx-domain] - Scaffolder for a new gem with a test suite.
+* [hexx-dependencies] - Scaffolder for the [IoC container], dummy app, and a new dependency from an external module.
+* [hexx-install] - A base generator for tasks, installing a gem inside a host application.
+* [hexx-validators] - Scaffolder for [activemodel] validators.
+* [hexx-services] - Scaffolder for [service objects][service_objects].
+* [hexx-entities] - Scaffolder for [virtus]-based entities.
+* [hexx-values] - Scaffolder for [virtus]-based value objects.
+
+There is one special submodule [hexx-suit] that provides shared dev/test environment.
+
+[hexx-dependencies]: https://github.com/nepalez/hexx-dependencies
+[hexx-domain]: https://github.com/nepalez/hexx-domain
+[hexx-entities]: https://github.com/nepalez/hexx-entities
+[hexx-install]: https://github.com/nepalez/hexx-install
+[hexx-services]: https://github.com/nepalez/hexx-services
+[hexx-suit]: https://github.com/nepalez/hexx-suit
+[hexx-validators]: https://github.com/nepalez/hexx-validators
+[hexx-values]: https://github.com/nepalez/hexx-values
+
+## Usage
+
+The usage of scaffolders is pretty standard.
+
+To view all the available options, run from CLI:
+
+```
+hexx -h
+```
+
+Every scaffolder has its own help, available via `-h` option, for example:
+
+```
+hexx service -h
+```
+
+For the usage of [hexx-suit] see [the gem's API][hexx-suit API].
+
+[hexx-suit API]: http://www.rubydoc.info/github/nepalez/hexx-suit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+group :test, :development do
+  gem "hexx"
+end
+```
+
+Then execute:
+
+```
+bundle
+```
+
+Or add it manually:
+
+```
+gem install hexx
+```
+
+## Compatibility
+
+Tested under MRI rubies >= 2.1. Rubies under 2.1 aren't supported.
+
+Uses [RSpec] 3.0+ for testing and [hexx-suit] for dev/test tools collection.
+
+## Contributing
+
+* Fork the project.
+* Read the [STYLEGUIDE].
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or version
+  (if you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+[STYLEGUIDE]: file:./config/metrics/STYLEGUIDE
+
+## License
+
+See [MIT LICENSE].

data/Rakefile

@@ -1,23 +1,17 @@
+# 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
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# Loads the Hexx::Suit and its tasks
+require "hexx-suit"
+Hexx::Suit.install_tasks
 
-RSpec::Core::RakeTask.new(:spec)
-
-task :default do
-  system "bundle exec rspec spec"
-end
-
-task :check do
-  system "coveralls report"
-  system "rubocop"
-  system "inch --pedantic"
-  system "metric_fu --no-cane --no-saikuro --no-roodi --no-hotspots --no-stats"
-end
+# Sets the Hexx::Suit :test task to default
+task default: "check:coverage"

data/config/initializer.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+# Adds specific configurations to RSpec for :sandbox and :capture tags
+require_relative "initializers/sandbox"
+require_relative "initializers/capture"

data/config/initializers/capture.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+# Captures and returns the results of capturing $stdout
+def capture_stdout
+  begin
+    $stdout = StringIO.new
+    yield
+  ensure
+    result, $stdout = $stdout.string, STDOUT
+  end
+  result
+end
+
+# Captures stdout of specifications with :capture tag
+RSpec.configure do |config|
+  config.around :each, :capture do |example|
+    capture_stdout { example.run }
+  end
+end

data/config/initializers/sandbox.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+# Re-creates tmp/sandbox before specs with :sandbox tag
+# Defines specific helpers and matchers for the specifications
+RSpec.configure do |config|
+
+  config.before :each, :sandbox do
+    require_relative "sandbox/helpers"
+    require_relative "sandbox/matchers"
+    prepare_sandbox
+  end
+
+  config.after :each, :sandbox do
+    clear_sandbox
+  end
+end

data/config/initializers/sandbox/helpers.rb

@@ -0,0 +1,38 @@
+# Path to the temporary `tmp/sandbox` folder
+#
+# @return [String]
+def sandbox
+  @sandbox ||= File.expand_path "tmp/sandbox"
+end
+
+# Clears the sandbox
+#
+# @return [undefined]
+def clear_sandbox
+  FileUtils.rm_rf sandbox
+end
+
+# Re-creates the sandbox
+#
+# @return [undefined]
+def prepare_sandbox
+  clear_sandbox
+  FileUtils.mkdir_p sandbox
+end
+
+# Runs code in a sandbox
+#
+# @return [undefined]
+def try_in_sandbox
+  FileUtils.cd(sandbox) { yield }
+end
+
+# Reads file in sandbox and returns its content
+#
+# @return [String]
+# @return [""]
+#   when the file is absent
+def read_in_sandbox(filename)
+  file = Dir[File.join(sandbox, filename)].first
+  file ? File.read(file) : ""
+end

data/config/initializers/sandbox/matchers.rb

@@ -0,0 +1,19 @@
+# Checks if a file with given name is present in sandbox.
+#
+# @example
+#   expect("some_file.rb").to be_present_in_sandbox
+RSpec::Matchers.define :be_present_in_sandbox do
+  match do |filename|
+    files = Dir[File.join(sandbox, filename)]
+    expect(files).to be_any
+  end
+end
+
+# Checks if a file with given name is absent in sandbox.
+#
+# @example
+#   expect("some_file.rb").to be_absent_in_sandbox
+RSpec::Matchers.define_negated_matcher(
+  :be_absent_in_sandbox,
+  :be_present_in_sandbox
+)

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.