aspect 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c759e692a1f7aaf002e2c474f45339003979c186
-  data.tar.gz: fad55ab8916d008d522556282a9bbf44539a38da
+  metadata.gz: ccb1a9fd117eb2ba52d9b95d31236dbfa549632d
+  data.tar.gz: 8b15bc652b3c3a495db45af32b8b6db68229f310
 SHA512:
-  metadata.gz: 83a6b3c76a8963b1301a44dab87dd2176570d27bb939f40e62f0dcc8df411994f511817611e291e0ff6506190dd0c41f8ffa4dcbd9f6cb2ae8f16557aec8b460
-  data.tar.gz: 2d5bba3bd952490bfb20ffbdf109a64d23f0c31923fe1a73eee2ebf6394e34650ee4a97309ec264724e02dafdd9fa984012bf6681e00ae490aaa238b00471050
+  metadata.gz: 2bf5e84b1503b8fd5a14faaae36b058e1557918c560e4c0a72d077fd0d0a9593704a062e855885f644667485f963980ee828fb29e5925ca3dcf443b6bc6885f4
+  data.tar.gz: 20eecb67017a3b55db952eb7c4172e378138ad724e5b2e1d455c8f3df6e20b00cd79a995d8e9057705d0393eef08c56cb10b5cdf9b0b92a62c490ac07eba91cb

data/Gemfile

@@ -3,13 +3,28 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "rake"
+  gem "rake"           # Project tasks
+  gem "version"        # Version management
+  gem "rspec"          # BDD Testing
+  gem "fuubar"         # RSpec formatter
+  gem "mutant-rspec"   # RSpec mutation testing
+  gem "reek"           # Code smell analyzer
+  gem "rubocop"        # Static code analyzer
+  gem "ruby-prof"      # Code profiler # TODO: No guard or rake. For use in integration tests.
+  gem "simplecov"      # Test coverage # TODO: No guard or rake. For use in integration tests.
+  gem "yard"           # Code documentation
+  gem "yardstick"      # Documentation coverage
+  gem "redcarpet"      # Markdown parser (for markdown within documentation)
+  gem "github-markup"  # Github Flavored Markdown (GFM) parsing
+  gem "guard"          # Filesystem event watching
 
-  gem "yard"
-
-  gem "rspec"
-  gem "fuubar"
-
-  gem "redcarpet"
-  gem "github-markup"
+  gem "guard-bundler"
+  gem "guard-shell"
+  gem "guard-rake"
+  gem "guard-rspec"
+  # gem "guard-mutant" # TODO: Broken, custom guard
+  gem "guard-reek"
+  gem "guard-rubocop"
+  gem "guard-yard"
+  gem "guard-yardstick"
 end

data/README.md

@@ -30,6 +30,12 @@ require "aspect"         # Would all files
 
 ## Usage
 
+### General
+
+No `Aspect` module will never define the `#initialize` or `.new` methods to avoid any strange errors
+when implementing your own functionality. At most, a module may *suggest* you call some kind of method
+within `#initialize` or `.new`.
+
 ### Aspect::HasAttributes
 
 **[Documentation](http://www.rubydoc.info/gems/aspect/Aspect/HasAttributes)**
@@ -66,6 +72,41 @@ p user.moderator? # => true
 p user.admin? # => true
 ```
 
+You can change the method names if you're including into an object which already
+defines `.attribute` and `#update_attributes`:
+
+```rb
+require "aspect/has_attributes"
+
+class User
+  include Aspect::HasAttributes(method: { define: :atr, update: :mass_assign })
+
+  atr(:name) { |value| value.to_s.strip }
+  atr(:moderator, query: true)
+  atr(:admin, query: true) { |value| @moderator && value }
+
+  def initialize(attributes={})
+    mass_assign(attributes)
+  end
+end
+```
+
+You may omit either method from being defined by passing `false` to it's `:method` option:
+
+```rb
+require "aspect/has_attributes"
+
+class User
+  include Aspect::HasAttributes(method: { define: false })
+
+  def initialize(attributes={})
+    update_attributes(attributes)
+  end
+end
+
+p User.respond_to?(:attribute) # => false
+```
+
 ## Copyright
 
 Copyright © 2016 Ryan Scott Lewis <ryan@rynet.us>.

data/Rakefile

@@ -1,20 +1,66 @@
+# Package task
+
 require "pathname"
 require "rubygems/package_task"
-require "rake/version_task"
-require "yard"
-require "rspec/core/rake_task"
 
-gemspec = Pathname.glob(Pathname.new(__FILE__).join("..", "*.gemspec")).first
+PROJECT_ROOT = Pathname.new(__FILE__).join("..").expand_path
+
+gemspec = Pathname.glob(PROJECT_ROOT.join("*.gemspec")).first
 spec = Gem::Specification.load(gemspec.to_s)
 
 Gem::PackageTask.new(spec) do |task|
   task.need_zip = false
 end
 
-Rake::VersionTask.new do |task|
-  task.with_git_tag = true
+# RSpec
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# Mutant
+
+desc "Mutation testing"
+task :mutant do
+  exec("bundle exec mutant --include lib --require aspect --use rspec Aspect* | tee spec/mutants.txt")
+end
+
+# Reek
+
+require "reek/rake/task"
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
 end
 
+# Rubocop
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new do |task|
+  task.patterns = ["lib/**/*.rb"]
+  # task.formatters = ["fuubar"]
+end
+
+# YARD
+
+require "yard"
+
 YARD::Rake::YardocTask.new
 
-RSpec::Core::RakeTask.new
+# Yardstick
+
+require "yardstick/rake/measurement"
+
+options = YAML.load_file(".yardstick.yml")
+Yardstick::Rake::Measurement.new(:yardstick, options) do |measurement|
+  measurement.output = PROJECT_ROOT.join("doc", "coverage.txt")
+end
+
+# Version
+
+require "rake/version_task"
+
+Rake::VersionTask.new do |task|
+  task.with_git_tag = true
+end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/aspect.gemspec

@@ -1,21 +1,18 @@
 require "pathname"
 
-Gem::Specification.new do |s|
+Gem::Specification.new do |spec|
   # Variables
-  s.summary = "A small collection of useful classes, modules, and mixins for plain old Ruby objects."
-  s.license = "MIT"
-
-  # Dependencies
-  s.add_dependency "version", "~> 1.0.0"
+  spec.summary = "A small collection of useful classes, modules, and mixins for plain old Ruby objects."
+  spec.license = "MIT"
 
   # Pragmatically set variables and constants
-  s.author        = "Ryan Scott Lewis"
-  s.email         = "ryan@rynet.us"
-  s.homepage      = "http://github.com/RyanScottLewis/#{s.name}"
-  s.version       = Pathname.glob("VERSION*").first.read rescue "0.0.0"
-  s.description   = s.summary
-  s.name          = Pathname.new(__FILE__).basename(".gemspec").to_s
-  s.require_paths = ["lib"]
-  s.files         = Dir["{Rakefile,Gemfile,README*,VERSION,LICENSE,*.gemspec,{lib,bin,examples,spec,test}/**/*}"]
-  s.test_files    = Dir["{examples,spec,test}/**/*"]
+  spec.author        = "Ryan Scott Lewis"
+  spec.email         = "ryan@rynet.us"
+  spec.homepage      = "http://github.com/RyanScottLewis/#{spec.name}"
+  spec.version       = Pathname.glob("VERSION*").first.read rescue "0.0.0"
+  spec.description   = spec.summary
+  spec.name          = Pathname.new(__FILE__).basename(".gemspec").to_s
+  spec.require_paths = ["lib"]
+  spec.files         = Dir["{Rakefile,Gemfile,README*,VERSION,LICENSE,*.gemspec,{lib,bin,examples,spec,test}/**/*}"]
+  spec.test_files    = Dir["{examples,spec,test}/**/*"]
 end

data/lib/aspect/has_attributes.rb

@@ -10,7 +10,7 @@ module Aspect
   #
   # Here's how I do it with [YARD](http://yardoc.org):
   #
-  # ```
+  # ```rb
   # class User
   #   include Aspect::HasAttributes
   #
@@ -42,7 +42,6 @@ module Aspect
   module HasAttributes
     # The class methods to extend into the object HasAttributes was included in.
     module ClassMethods
-      # @method attribute
       # Define an attribute on the object.
       #
       # @example Simple accessor
@@ -138,41 +137,53 @@ module Aspect
       #   user.admin = true
       #   user.moderator? # => true
       #   user.admin? # => true
+      # @param [#to_sym] name The name of the attribute and instance variable.
       # @param [Hash, #to_hash] options The options for defining and passing to the block.
       # @option options [Boolean] :getter (true) Determines whether to define an attribute getter.
       # @option options [Boolean] :setter (true) Determines whether to define an attribute setter.
       # @option options [Boolean] :query (false)
       #   Determines whether to define as a query attribute, with the getter having a question mark appended to the
       #   method name and the setter converting the value or block into a boolean using bang-bang (`!!`).
+      # @option options [#to_sym] :method (nil) The method name to send to the value after executing
       # @yieldparam [Object] value The value given to the setter method.
       # @yieldparam [Hash] options The options given when defining, given to the setter method.
       # @yieldreturn [Object] The value to set the instance variable as.
       # @return [Object]
-      def attribute(name, options={}, &block)
+      def attribute(name, options={}, &block) # TODO: Should break out into protected methods?
+        name = name.to_sym
+
         options = options.to_h unless options.is_a?(Hash)
-        options = { getter: true, setter: true, query: false }.merge(options)
+        options = { getter: true, setter: true }.merge(options)
 
         if options[:getter]
-          if options[:query]
-            define_method("#{name}?") { !!instance_variable_get("@#{name}") }
-          else
-            attr_reader(name)
+          options[:getter] = options[:getter] == true ? {} : options[:getter].to_h
+
+          options[:getter][:method]          = options[:getter][:method].to_sym          if options[:getter][:method]
+          options[:getter][:instance_method] = options[:getter][:instance_method].to_sym if options[:getter][:instance_method]
+
+          method_name = options[:query] ? "#{name}?" : name
+          define_method(method_name) do
+            value = instance_variable_get("@#{name}")
+            value = value.send(options[:getter][:method]) if options[:getter][:method]
+            value = method(options[:getter][:instance_method]).call(value) if options[:getter][:instance_method]
+
+            options[:query] ? !!value : value
           end
         end
 
         if options[:setter]
-          if options[:query]
-            define_method("#{name}=") do |value|
-              value = instance_exec(value, options, &block) unless block.nil?
+          options[:setter] = options[:setter] == true ? {} : options[:setter].to_h
+
+          options[:setter][:method]          = options[:setter][:method].to_sym          if options[:setter][:method]
+          options[:setter][:instance_method] = options[:setter][:instance_method].to_sym if options[:setter][:instance_method]
 
-              instance_variable_set("@#{name}", !!value)
-            end
-          else
-            define_method("#{name}=") do |value|
-              value = instance_exec(value, options, &block) unless block.nil?
+          define_method("#{name}=") do |value|
+            value = instance_exec(value, options, &block) unless block.nil?
+            value = value.send(options[:setter][:method]) if options[:setter][:method]
+            value = method(options[:setter][:instance_method]).call(value) if options[:setter][:instance_method]
+            value = options[:query] ? !!value : value
 
-              instance_variable_set("@#{name}", value)
-            end
+            instance_variable_set("@#{name}", value)
           end
         end
 
@@ -181,7 +192,7 @@ module Aspect
     end
 
     class << self
-      # On include hook.
+      # On include hook to extend `ClassMethods`.
       def included(base)
         base.send(:extend, ClassMethods)
       end
@@ -231,9 +242,7 @@ module Aspect
     # @param [Hash, #to_h] attributes
     # @return [Object] This object.
     def update_attributes(attributes={})
-      attributes = attributes.to_h unless attributes.is_a?(Hash)
-
-      attributes.each { |name, value| send("#{name}=", value) }
+      attributes.to_h.each { |name, value| send("#{name}=", value) }
     end
   end
 end

data/lib/aspect/has_registry.rb

@@ -0,0 +1,28 @@
+module Aspect
+  # Extend in a `Class` to register new instances with a name in a collection named `.registry`.
+  module HasRegistry # TODO: Allow to register Classes, not just instances
+    # All defined instances.
+    #
+    # @return [{Symbol => Object}]
+    def registry
+      @registry ||= {}
+    end
+
+    # Register an instance.
+    #
+    # @param [#to_sym] name
+    # @yield The new instance's scope.
+    # @return [Object]
+    def register(name, *arguments, &block)
+      registry[name.to_sym] = new(*arguments, &block)
+    end
+
+    # Get whether an instance is registered.
+    #
+    # @param [#to_sym] name
+    # @return [Boolean]
+    def registered?(name)
+      @registry.keys.include?(name.to_sym)
+    end
+  end
+end

data/lib/aspect/message_transform.rb

@@ -0,0 +1,97 @@
+module Aspect
+  # Transforms a `Hash` into human language.
+  #
+  # @example Getting using `Symbol`.
+  #   require "aspect/message_transform"
+  #
+  #   message = Aspect::MessageTransform.new(login: "Click to login", body: "Lorem ipsum")
+  #
+  #   p message.to_a(:login, :body) # => ["Click to login", "Lorem ipsum"]
+  #   p message.to_h(:login, :body) # => { login: "Click to login", body: "Lorem ipsum" }
+  #   p message.to_s(:login, :body) # => "Click to login, Lorem ipsum"
+  #
+  #   p message.to_a(:body) # => ["Lorem ipsum"]
+  #   p message.to_h(:body) # => { body: "Lorem ipsum" }
+  #   p message.to_s(:body) # => "Lorem ipsum"
+  # @example Getting using `Hash`.
+  #   require "aspect/message_transform"
+  #
+  #   message = Aspect::MessageTransform.new(login: "Click to login", body: "Lorem ipsum")
+  #
+  #   p message.to_a(login: true, body: true) # => ["Click to login", "Lorem ipsum"]
+  #   p message.to_h(login: true, body: true) # => { login: "Click to login", body: "Lorem ipsum" }
+  #   p message.to_s(login: true, body: true) # => "Click to login, Lorem ipsum"
+  #
+  #   p message.to_a(login: false, body: true) # => ["Lorem ipsum"]
+  #   p message.to_h(login: false, body: true) # => { body: "Lorem ipsum" }
+  #   p message.to_s(login: false, body: true) # => "Lorem ipsum"
+  #
+  #   p message.to_a(body: true) # => ["Lorem ipsum"]
+  #   p message.to_h(body: true) # => { body: "Lorem ipsum" }
+  #   p message.to_s(body: true) # => "Lorem ipsum"
+  # @example Output formatting and separator.
+  #   require "aspect/message_transform"
+  #
+  #   message = Aspect::MessageTransform.new(login: "Click to login", body: "Lorem ipsum")
+  #
+  #   message.separator = " - "
+  #   message.formatter { |value| "<div>#{value}</div>" }
+  #   # Or (can be anything responding to #call(value)):
+  #   # message.formatter = -> { |value| "<div>#{value}</div>" }
+  #
+  #   p message.to_a(:login, :body) # => ["<div>Click to login</div>", "<div>Lorem ipsum</div>"]
+  #   p message.to_h(:login, :body) # => { login: "<div>Click to login</div>", body: "<div>Lorem ipsum</div>" }
+  #   p message.to_s(:login, :body) # => "<div>Click to login</div> - <div>Lorem ipsum</div>"
+  # @example Message interpolation.
+  #   require "aspect/message_transform"
+  #
+  #   message = Aspect::MessageTransform.new(hello: "Hello %{hello}!")
+  #
+  #   p message.to_s(hello: "world") # => "Hello world!"
+  # @example Getting with a multi-level `Hash`.
+  #   require "aspect/message_transform"
+  #
+  #   message = Aspect::MessageTransform.new(header: "My App", body: { title: "Some Page", hello: "Hello %{hello}!" })
+  #
+  #   p message.to_s(header: true)             # => "My App"
+  #   p message.to_s(body: { title: true })    # => "Some Page"
+  #   p message.to_s(body: { hello: "world" }) # => "Hello world!"
+  # @example Getting with `String` notation.
+  #   require "aspect/message_transform"
+  #
+  #   message = Aspect::MessageTransform.new(header: "My App", body: { title: "Some Page", hello: "Hello %{hello}!" })
+  #
+  #   p message.to_s("header")                              # => "My App"
+  #   p message.to_s("body.title")                          # => "Some Page"
+  #   p message.to_s("body.hello" => "world")               # => "Hello world!"
+  #   p message.to_a("body.title", "body.hello" => "world") # => ["Some Page", "Hello world!"]
+  # @example Internationalization (I18N) using multi-level `Hash`, compatible with {Verifier} output.
+  #   require "aspect/message_transform"
+  #
+  #   dictionary = {
+  #     en: {
+  #       presence: "%{attribute} must not be blank",
+  #       greater_than_or_equal_to: "%{attribute} must be greater than or equal to %{greater_than_or_equal_to}"
+  #     },
+  #     es: {
+  #       presence: "%{attribute} no debe estar en blanco",
+  #       greater_than_or_equal_to: "%{attribute} debe ser mayor que o igual a %{greater_than_or_equal_to}"
+  #     }
+  #   }
+  #
+  #   error_message = Aspect::MessageTransform.new(dictionary)
+  #
+  #   error_message.to_s(en: { attribute: "age", presence: true, greater_than_or_equal_to: 18 }) # => "age must not be blank, age must be greater than or equal to 18"
+  #   error_message.to_s(es: { attribute: "edad", presence: true, greater_than_or_equal_to: 18 }) # => "edad no debe estar en blanco, edad debe ser mayor que o igual a 18"
+  class MessageTransform
+    def initialize(expectations={})
+      @expectations = expectations.to_h
+    end
+
+    def inspect
+      memory_location = (object_id << 1).to_s(16)
+
+      "#<#{self.class}>:0x#{memory_location} #{@expectations.inspect}>"
+    end
+  end
+end

data/lib/aspect/validator.rb

@@ -0,0 +1,112 @@
+require "aspect/verifier" if Kernel.respond_to?(:require)
+
+module Aspect
+  # Verify a set of checks on a list of an object's attributes.
+  #
+  # Uses a {Verifier} for each attribute run the checks.
+  #
+  # @example Basic usage.
+  #   require "aspect/validator"
+  #
+  #   user = User.new(name: "Foo Bar")
+  #   user_validator = Aspect::Validator.new
+  #
+  #   user_validator.verify(:name, presence: true)
+  #   user_validator.verify(:age, presence: true, integer: true, greater_than_or_equal_to: 18)
+  #
+  #   user.age = nil
+  #   user_validator.validate(user) # => { age: { presence: true, integer: true, greater_than_or_equal_to: 18 } }
+  #
+  #   user.age = 17.98
+  #   user_validator.validate(user) # => { age: { integer: true, greater_than_or_equal_to: 18 } }
+  #
+  #   user.name = ""
+  #   user.age = 17
+  #   user_validator.validate(user) # => { name: { presence: true }, age: { greater_than_or_equal_to: 18 } }
+  #
+  #   user.name = "Foo Bar"
+  #   user.age = 25
+  #   user_validator.validate(user) # => nil # Valid
+  # @example Initialize with `Hash`
+  #   Aspect::Validator.new(name: { presence: true }, age: { presence: true, integer: true, greater_than_or_equal_to: 18 })
+  # @example Displaying validation errors with {MessageTransform}.
+  #   require "aspect/validator"
+  #   require "aspect/message_transform"
+  #
+  #   user = User.new(name: "Foo Bar")
+  #
+  #   error_message = Aspect::MessageTransform.new(
+  #     presence: "Must be given.",
+  #     integer: "Must give a number.",
+  #     greater_than_or_equal_to: "Must be %{greater_than_or_equal_to} or greater."
+  #   )
+  #
+  #   user_validator = Aspect::Validator.new
+  #   user_validator.verify(:name, presence: true)
+  #   user_validator.verify(:age, presence: true, integer: true, greater_than_or_equal_to: 18)
+  #
+  #   user_errors = user_validator.validate(user)
+  #
+  #   puts error_message.to_s(user_errors) if user_errors
+  # @example Displaying validation errors with {MessageTransform} and Internationalization (I18N).
+  #   require "aspect/validator"
+  #   require "aspect/message_transform"
+  #
+  #   user = User.new(name: "Foo Bar")
+  #
+  #   dictionary_data = {
+  #     en: {
+  #       attributes: {
+  #         age: "age"
+  #       },
+  #       errors: {
+  #         presence: "must not be blank",
+  #         greater_than_or_equal_to: "must be greater than or equal to %{value}"
+  #       }
+  #     },
+  #     es: {
+  #       attributes: {
+  #         age: "edad"
+  #       },
+  #       errors: {
+  #         presence: "no debe estar en blanco",
+  #         greater_than_or_equal_to: "debe ser mayor que o igual a %{value}"
+  #       }
+  #     }
+  #   }
+  #
+  #   language = :en
+  #   dictionary = Aspect::MessageTransform.new(dictionary_data)
+  #   user_validator = Aspect::Validator.new(name: { presence: true }, age: { presence: true, greater_than_or_equal_to: 18 })
+  #
+  #   user_errors = user_validator.validate(user)
+  #
+  #   if user_errors
+  #     user_errors.each do |attribute_name, error|
+  #       attribute_name = dictionary.to_s("#{language}.attributes.#{attribute_name}")
+  #
+  #       puts "#{attribute_name}: " + dictionary.to_s("#{language}.errors" => error)
+  #     end
+  #   end
+  class Validator
+    def initialize
+      @verifications = []
+    end
+
+    def verify(attributes={})
+      @verifications << Verifier.new(attributes)
+    end
+
+    def validate(object)
+      errors = Errors.new
+
+      @verifications.each do |constraint|
+        value = object.send(constraint.name)
+        errors = constraint.validate(value)
+        # errors.add() # TODO
+      end
+
+      errors
+    end
+  end
+end