aspect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c759e692a1f7aaf002e2c474f45339003979c186
+  data.tar.gz: fad55ab8916d008d522556282a9bbf44539a38da
+SHA512:
+  metadata.gz: 83a6b3c76a8963b1301a44dab87dd2176570d27bb939f40e62f0dcc8df411994f511817611e291e0ff6506190dd0c41f8ffa4dcbd9f6cb2ae8f16557aec8b460
+  data.tar.gz: 2d5bba3bd952490bfb20ffbdf109a64d23f0c31923fe1a73eee2ebf6394e34650ee4a97309ec264724e02dafdd9fa984012bf6681e00ae490aaa238b00471050

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rake"
+
+  gem "yard"
+
+  gem "rspec"
+  gem "fuubar"
+
+  gem "redcarpet"
+  gem "github-markup"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Ryan Scott Lewis <ryan@rynet.us>
+
+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,73 @@
+# Aspect
+
+A small collection of useful classes, modules, and mixins for plain old Ruby objects.
+
+## Install
+
+### Bundler: `gem "aspect"`
+
+### RubyGems: `gem install aspect`
+
+## Requiring
+
+You should cherry pick the classes/modules you want to load like so:
+
+```rb
+require "aspect/has_attributes"
+
+class User
+  include Aspect::HasAttributes
+end
+```
+
+You can load all classes/modules in a module by requiring just the directory:
+
+```rb
+require "aspect/foo/bar" # Would load aspect/foo/bar/**/*.rb
+require "aspect/foo"     # Would load aspect/foo/**/*.rb
+require "aspect"         # Would all files
+```
+
+## Usage
+
+### Aspect::HasAttributes
+
+**[Documentation](http://www.rubydoc.info/gems/aspect/Aspect/HasAttributes)**
+
+```rb
+require "aspect/has_attributes"
+
+class User
+  include Aspect::HasAttributes
+
+  attribute(:name) { |value| value.to_s.strip }
+  attribute(:moderator, query: true)
+  attribute(:admin, query: true) { |value| @moderator && value }
+
+  def initialize(attributes={})
+    update_attributes(attributes)
+  end
+end
+
+user = User.new(name: "  Ezio   ")
+
+p user.name # => "Ezio"
+user.name = :Ezio
+p user.name # => "Ezio"
+
+p user.moderator? # => false
+p user.admin? # => false
+user.admin = true
+p user.moderator? # => false
+p user.admin? # => false
+user.moderator = "truthy value"
+user.admin = true
+p user.moderator? # => true
+p user.admin? # => true
+```
+
+## Copyright
+
+Copyright © 2016 Ryan Scott Lewis <ryan@rynet.us>.
+
+The MIT License (MIT) - See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,20 @@
+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
+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
+end
+
+YARD::Rake::YardocTask.new
+
+RSpec::Core::RakeTask.new

data/VERSION

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

data/aspect.gemspec

@@ -0,0 +1,21 @@
+require "pathname"
+
+Gem::Specification.new do |s|
+  # 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"
+
+  # 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}/**/*"]
+end

data/lib/aspect.rb

@@ -0,0 +1,8 @@
+require "version"
+
+# A small collection of useful mixins for plain old Ruby objects.
+module Aspect
+  is_versioned
+end
+
+require "aspect/has_attributes"

data/lib/aspect/has_attributes.rb

@@ -0,0 +1,239 @@
+module Aspect
+  # Easily define attribute getter/setter/accessors on an object with a `.attribute` class method.
+  #
+  # This also defines the `#update_attributes` instance method to use for mass assignment.
+  #
+  # **Documentation Notes**
+  #
+  # Since `.attribute` is a method which dynamically defines methods, you may need to use a special declaration
+  # in order to associate the documentation to the method.
+  #
+  # Here's how I do it with [YARD](http://yardoc.org):
+  #
+  # ```
+  # class User
+  #   include Aspect::HasAttributes
+  #
+  #   # @method name
+  #   # Get the name.
+  #   #
+  #   # @return [String]
+  #
+  #   # @method name=
+  #   # Set the name.
+  #   #
+  #   # @param [#to_s] value
+  #   # @return [String]
+  #   attribute(:name) { |value| value.to_s.strip }
+  #
+  #   # @method admin?
+  #   # Get whether this user is an admin.
+  #   #
+  #   # @return [Boolean]
+  #
+  #   # @method admin=
+  #   # Set whether this user is an admin.
+  #   #
+  #   # @param [Boolean] value
+  #   # @return [Boolean]
+  #   attribute(:admin, query: true)
+  # end
+  # ```
+  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
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     attribute(:name)
+      #   end
+      #
+      #   user = User.new
+      #   user.name = "Ezio Auditore"
+      #   user.name # => "Ezio Auditore"
+      # @example Simple getter
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     attribute(:name, setter: false)
+      #
+      #     def initialize(name)
+      #       @name = name
+      #     end
+      #   end
+      #
+      #   user = User.new("Ezio Auditore")
+      #   user.name # => "Ezio Auditore"
+      # @example Simple setter
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     attribute(:name, getter: false)
+      #
+      #     def name
+      #       @name.strip
+      #     end
+      #   end
+      #
+      #   user = User.new
+      #   user.name = "  Ezio Auditore  "
+      #   user.name # => "Ezio Auditore"
+      # @example Accessor with block
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     attribute(:name) { |value| value.to_s.strip }
+      #   end
+      #
+      #   user = User.new
+      #   user.name = "  Ezio Auditore  "
+      #   user.name # => "Ezio Auditore"
+      # @example Accessor with block, passing options
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     conversion_block = Proc.new { |value, options| "#{options[:prefix]}-#{value.to_s.strip}" }
+      #     attribute(:foo, prefix: "Foo", &conversion_block)
+      #     attribute(:bar, prefix: "Bar", &conversion_block)
+      #   end
+      #
+      #   user = User.new
+      #   user.foo = "  Thing  "
+      #   user.foo # => "Foo-Thing"
+      #   user.bar = "   Thingy"
+      #   user.bar # => "Bar-Thingy"
+      # @example Query accessor
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     attribute(:admin, query: true)
+      #   end
+      #
+      #   user = User.new
+      #   user.admin? # => false
+      #   user.admin = "yep" # Accepts truthy values
+      #   user.admin? # => true
+      # @example Query accessor with block
+      #   class User
+      #     include Aspect::HasAttributes
+      #
+      #     attribute(:moderator, query: true)
+      #     attribute(:admin, query: true) { |value| @moderator && value }
+      #   end
+      #
+      #   user = User.new
+      #
+      #   user.moderator? # => false
+      #   user.admin? # => false
+      #   user.admin = true
+      #   user.admin? # => false
+      #
+      #   user.moderator = true
+      #   user.moderator? # => true
+      #   user.admin? # => false
+      #   user.admin = true
+      #   user.moderator? # => true
+      #   user.admin? # => true
+      # @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 (`!!`).
+      # @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)
+        options = options.to_h unless options.is_a?(Hash)
+        options = { getter: true, setter: true, query: false }.merge(options)
+
+        if options[:getter]
+          if options[:query]
+            define_method("#{name}?") { !!instance_variable_get("@#{name}") }
+          else
+            attr_reader(name)
+          end
+        end
+
+        if options[:setter]
+          if options[:query]
+            define_method("#{name}=") do |value|
+              value = instance_exec(value, options, &block) unless block.nil?
+
+              instance_variable_set("@#{name}", !!value)
+            end
+          else
+            define_method("#{name}=") do |value|
+              value = instance_exec(value, options, &block) unless block.nil?
+
+              instance_variable_set("@#{name}", value)
+            end
+          end
+        end
+
+        self
+      end
+    end
+
+    class << self
+      # On include hook.
+      def included(base)
+        base.send(:extend, ClassMethods)
+      end
+    end
+
+    # @method update_attributes
+    # Update attributes on this object.
+    #
+    # @example
+    #   class User
+    #     include Aspect::HasAttributes
+    #
+    #     attribute(:name) { |value| value.to_s.strip }
+    #     attribute(:moderator, query: true)
+    #     attribute(:admin, query: true) { |value| @moderator ? value : false }
+    #   end
+    #
+    #   user = User.new
+    #
+    #   user.name # => nil
+    #   user.moderator? # => false
+    #   user.admin? # => false
+    #
+    #   user.update_attributes(name: "  Ezio Auditore  ", moderator: true)
+    #
+    #   user.name # => "Ezio Auditore"
+    #   user.moderator? # => true
+    #   user.admin? # => false
+    # @example In `#initialize`
+    #   class User
+    #     include Aspect::HasAttributes
+    #
+    #     def initialize(attributes={})
+    #       update_attributes(attributes)
+    #     end
+    #
+    #     attribute(:name) { |value| value.to_s.strip }
+    #     attribute(:moderator, query: true)
+    #     attribute(:admin, query: true) { |value| @moderator ? value : false }
+    #   end
+    #
+    #   user = User.new(name: "  Ezio Auditore  ", moderator: true)
+    #
+    #   user.name # => "Ezio Auditore"
+    #   user.moderator? # => true
+    #   user.admin? # => false
+    # @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) }
+    end
+  end
+end

data/spec/lib/aspect/has_attributes_spec.rb

@@ -0,0 +1,265 @@
+require "spec_helper"
+
+describe Aspect::HasAttributes do
+  describe ".attribute" do
+    context "when no options are given" do
+      context "and no block is given" do
+        let(:instance) do
+          instance_class = Class.new do
+            include Aspect::HasAttributes
+
+            attribute(:name)
+          end
+
+          instance_class.new
+        end
+
+        it "should define a getter and a setter which uses the argument given to set the instance variable" do
+          expect(instance.name).to eq(nil)
+          instance.name = "foo"
+          expect(instance.name).to eq("foo")
+        end
+      end
+
+      context "and a block is given" do
+        let(:instance) do
+          instance_class = Class.new do
+            include Aspect::HasAttributes
+
+            attribute(:name) { |value| value.to_s }
+          end
+
+          instance_class.new
+        end
+
+        it "should define a getter and a setter which uses the return value of the block to set the instance variable" do
+          expect(instance.name).to eq(nil)
+          instance.name = 123
+          expect(instance.name).to eq("123")
+        end
+      end
+    end
+
+    context "when the :getter option is given" do
+      context "and it's truthy" do
+        let(:instance) do
+          instance_class = Class.new do
+            include Aspect::HasAttributes
+
+            attribute(:name, getter: true)
+          end
+
+          instance_class.new
+        end
+
+        it "should define a query getter which uses the argument given to set the instance variable" do
+          expect(instance.name).to eq(nil)
+        end
+      end
+
+      context "and it's falsey" do
+        let(:instance) do
+          instance_class = Class.new do
+            include Aspect::HasAttributes
+
+            attribute(:name, getter: false)
+          end
+
+          instance_class.new
+        end
+
+        it "should not define a getter" do
+          expect(instance.respond_to?(:name)).to eq(false)
+        end
+      end
+    end
+
+    context "when the :setter option is given" do
+      context "and no block is given" do
+        context "and it's truthy" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:name, setter: true)
+            end
+
+            instance_class.new
+          end
+
+          it "should define a query setter which uses the argument given to set the instance variable" do
+            expect(instance.name).to eq(nil)
+            instance.name = "foobar"
+            expect(instance.name).to eq("foobar")
+          end
+        end
+
+        context "and it's falsey" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:admin, query: false)
+            end
+
+            instance_class.new
+          end
+
+          it "should define a getter and a setter which uses the return value of the block to set the instance variable" do
+            expect(instance.admin).to eq(nil)
+            instance.admin = "truthy"
+            expect(instance.admin).to eq("truthy")
+          end
+        end
+      end
+
+      context "and a block is given" do
+        context "and it's truthy" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:moderator, query: true)
+              attribute(:admin, query: true) { |value| @moderator && value }
+            end
+
+            instance_class.new
+          end
+
+          it "should define a query getter and a query setter which uses the return value of the block to set the instance variable as a truthy value" do
+            expect(instance.moderator?).to eq(false)
+            expect(instance.admin?).to eq(false)
+            instance.admin = "truthy"
+            expect(instance.admin?).to eq(false)
+            instance.moderator = true
+            instance.admin = "truthy"
+            expect(instance.moderator?).to eq(true)
+            expect(instance.admin?).to eq(true)
+          end
+        end
+
+        context "and it's falsey" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:admin, query: false) { "return value" }
+            end
+
+            instance_class.new
+          end
+
+          it "should define a getter and a setter which uses the return value of the block to set the instance variable" do
+            expect(instance.admin).to eq(nil)
+            instance.admin = "anything"
+            expect(instance.admin).to eq("return value")
+          end
+        end
+      end
+    end
+
+    context "when the :query option is given" do
+      context "and no block is given" do
+        context "and it's truthy" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:admin, query: true)
+            end
+
+            instance_class.new
+          end
+
+          it "should define a query getter and a query setter which uses the argument given to set the instance variable as a truthy value" do
+            expect(instance.admin?).to eq(false)
+            instance.admin = "truthy"
+            expect(instance.admin?).to eq(true)
+          end
+        end
+
+        context "and it's falsey" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:admin, query: false)
+            end
+
+            instance_class.new
+          end
+
+          it "should define a getter and a setter which uses the return value of the block to set the instance variable" do
+            expect(instance.admin).to eq(nil)
+            instance.admin = "truthy"
+            expect(instance.admin).to eq("truthy")
+          end
+        end
+      end
+
+      context "and a block is given" do
+        context "and it's truthy" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:moderator, query: true)
+              attribute(:admin, query: true) { |value| @moderator && value }
+            end
+
+            instance_class.new
+          end
+
+          it "should define a query getter and a query setter which uses the return value of the block to set the instance variable as a truthy value" do
+            expect(instance.moderator?).to eq(false)
+            expect(instance.admin?).to eq(false)
+            instance.admin = "truthy"
+            expect(instance.admin?).to eq(false)
+            instance.moderator = true
+            instance.admin = "truthy"
+            expect(instance.moderator?).to eq(true)
+            expect(instance.admin?).to eq(true)
+          end
+        end
+
+        context "and it's falsey" do
+          let(:instance) do
+            instance_class = Class.new do
+              include Aspect::HasAttributes
+
+              attribute(:admin, query: false) { "return value" }
+            end
+
+            instance_class.new
+          end
+
+          it "should define a getter and a setter which uses the return value of the block to set the instance variable" do
+            expect(instance.admin).to eq(nil)
+            instance.admin = "anything"
+            expect(instance.admin).to eq("return value")
+          end
+        end
+      end
+    end
+  end
+
+  describe "#update_attributes" do
+    let(:instance) do
+      class_instance = Class.new do
+        include Aspect::HasAttributes
+
+        attr_accessor :name
+        attr_accessor :age
+      end
+
+      class_instance.new
+    end
+
+    it "should update the attributes on the instance" do
+      instance.update_attributes(name: "Foo Bar", age: 123)
+
+      expect(instance.name).to eq("Foo Bar")
+      expect(instance.age).to eq(123)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "aspect"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: aspect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A small collection of useful classes, modules, and mixins for plain old
+  Ruby objects.
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- aspect.gemspec
+- lib/aspect.rb
+- lib/aspect/has_attributes.rb
+- spec/lib/aspect/has_attributes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/RyanScottLewis/
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A small collection of useful classes, modules, and mixins for plain old Ruby
+  objects.
+test_files:
+- spec/spec_helper.rb
+- spec/lib/aspect/has_attributes_spec.rb