lean-attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6b251b6f7693a6a788b8cf3f006658fe11e256c
+  data.tar.gz: d117bf7bb0f11f7857516109bc0416a8ab6d639d
+SHA512:
+  metadata.gz: cddfdcbf8ee64247a616dc021339322f7aeb19fa7156fad8934eedf8fe005b5fbcbbf31b8fc9d9b0e2582be402282553495de9d87b0173c64f7193362634e4d3
+  data.tar.gz: e2e7859b6340308338c77bcced6816d2d9f226912e134997e4b4bf06c5933915649aa7116f66037054abb57f4f6e89c724ba12c12bf971797c55cbb3b1263c02

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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,8 @@
+# Lean::Attributes
+
+## Status
+[![Build Status](https://travis-ci.org/lleolin/lean-attributes.svg)](https://travis-ci.org/lleolin/lean-attributes)
+[![Test Coverage](https://codeclimate.com/github/lleolin/lean-attributes/badges/coverage.svg)](https://codeclimate.com/github/lleolin/lean-attributes/coverage)
+[![Code Climate](https://codeclimate.com/github/lleolin/lean-attributes/badges/gpa.svg)](https://codeclimate.com/github/lleolin/lean-attributes)
+[![Dependency Status](https://gemnasium.com/lleolin/lean-attributes.svg)](https://gemnasium.com/lleolin/lean-attributes)
+[![Inline docs](http://inch-ci.org/github/lotus/model.svg?branch=master)](http://inch-ci.org/github/lleolin/lean-attributes)

data/lib/lean-attributes.rb

@@ -0,0 +1 @@
+require 'lean-attributes/attributes'

data/lib/lean-attributes/attributes.rb

@@ -0,0 +1,14 @@
+require 'lean-attributes/attributes/class_methods'
+require 'lean-attributes/attributes/coercion'
+require 'lean-attributes/attributes/initializer'
+
+module Lean
+  module Attributes
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include Coercion
+      end
+    end
+  end
+end

data/lib/lean-attributes/attributes/attribute.rb

@@ -0,0 +1,78 @@
+module Lean
+  module Attributes
+    class Attribute
+      attr_reader :name
+
+      def initialize(options = {})
+        @default_value  = options[:default_value]
+        @name           = options[:name]
+        @parent_class   = options[:parent_class]
+        @type           = options[:type].to_s
+      end
+
+      def coercion_method
+        <<-EOS
+          def #{coercion_method_name(name)}(value)
+            #{coercion_method_name}(value)
+          end
+        EOS
+      end
+
+      def coercible?
+        return @coercible unless @coercible.nil?
+
+        @coercible = @parent_class.method_defined?(coercion_method_name)
+      end
+
+      def coercion_method_name(from = nil)
+        ['coerce', from, 'to', @type.downcase].compact.join('_')
+      end
+
+      def default_value
+        return "send(:#{@default_value})" if @default_value.is_a?(Symbol) &&
+                                             !@type.is_a?(Symbol)
+
+        @default_value.inspect
+      end
+
+      def getter_method
+        return getter_method_with_default unless @default_value.nil?
+
+        "attr_reader :#{@name}"
+      end
+
+      def getter_method_with_default
+        <<-EOS
+          def #{name}
+            @#{name} ||= #{default_value}
+          end
+        EOS
+      end
+
+      def name
+        @name.to_sym
+      end
+
+      def setter_method
+        <<-EOS
+          def #{name}=(value)
+            #{setter_method_coercion}
+            @#{name} = value
+          end
+        EOS
+      end
+
+      def setter_method_coercion
+        return unless coercible?
+
+        <<-EOS
+          value = #{coercion_method_name}(value) unless value.is_a?(#{@type})
+        EOS
+      end
+
+      # def type_coercion_method_name
+      #   @type_coercion_method_name ||= :"coerce_to_#{@type.downcase}"
+      # end
+    end
+  end
+end

data/lib/lean-attributes/attributes/class_methods.rb

@@ -0,0 +1,19 @@
+require 'lean-attributes/attributes/attribute'
+
+module Lean
+  module Attributes
+    module ClassMethods
+      def attribute(name, type, options = {})
+        attribute = Attribute.new(default_value: options[:default],
+                                  name: name, parent_class: self, type: type)
+
+        class_eval(attribute.coercion_method, __FILE__, __LINE__ + 1) \
+          if attribute.coercible?
+        class_eval(attribute.getter_method,   __FILE__, __LINE__ + 1)
+        class_eval(attribute.setter_method,   __FILE__, __LINE__ + 1)
+
+        attribute
+      end
+    end
+  end
+end

data/lib/lean-attributes/attributes/coercion.rb

@@ -0,0 +1,37 @@
+module Lean
+  module Attributes
+    module Coercion
+      def coerce_to_array(value)
+        Array(value) unless value.nil?
+      end
+
+      def coerce_to_bigdecimal(value)
+        BigDecimal.new(value, 0) unless value.nil?
+      end
+
+      def coerce_to_date(value)
+        Date.parse(value) unless value.nil?
+      end
+
+      def coerce_to_datetime(value)
+        DateTime.parse(value) unless value.nil?
+      end
+
+      def coerce_to_integer(value)
+        value.to_i unless value.nil?
+      end
+
+      def coerce_to_string(value)
+        value.to_s unless value.nil?
+      end
+
+      def coerce_to_symbol(value)
+        value.to_sym unless value.nil?
+      end
+
+      def coerce_to_time(value)
+        Time.new(value) unless value.nil?
+      end
+    end
+  end
+end

data/lib/lean-attributes/attributes/initializer.rb

@@ -0,0 +1,11 @@
+module Lean
+  module Attributes
+    module Initializer
+      def initialize(attributes = {})
+        attributes.each do |name, value|
+          send("#{name}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/lean-attributes/version.rb

@@ -0,0 +1,5 @@
+module Lean
+  module Attributes
+    VERSION = '0.0.1'
+  end
+end

data/spec/fixtures.rb

@@ -0,0 +1,37 @@
+require 'bigdecimal'
+
+class Medium
+  include Lean::Attributes
+
+  attribute :authors,   Array
+  attribute :finished,  DateTime
+  attribute :price,     BigDecimal
+  attribute :published, Date
+  attribute :rate,      Float
+  attribute :sold,      Time
+  attribute :title,     String
+end
+
+class Book < Medium
+  attribute :format,  Symbol, default: :hardcover
+  attribute :pages,   Integer
+end
+
+class Author
+  include Lean::Attributes
+  include Lean::Attributes::Initializer
+
+  attribute :age,  Integer
+  attribute :name, String
+end
+
+class ReadingProgress
+  include Lean::Attributes
+
+  attribute :date, Time,    default: :time_now
+  attribute :page, Integer, default: 1
+
+  def time_now
+    Time.new('2015-09-08').utc
+  end
+end

data/spec/lean_attributes_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'Lean::Attributes' do
+  context 'inclusive class' do
+    let(:book) do
+      Book.new.tap do |book|
+        book.title      = :"War and Peace"
+        book.pages      = '1'
+        book.authors    = 'Leo Tolstoy'
+        book.published  = '1869-01-01'
+        book.sold       = '2015-09-08'
+        book.finished   = '2015-09-10'
+        book.price      = 10.00
+        book.format     = 'paperback'
+      end
+    end
+
+    it 'has no initializer'  do
+      expect { Book.new(title: 'War and Peace') } \
+        .to raise_error(ArgumentError)
+    end
+
+    it 'has coercible and writable attributes' do
+      expect(book.title).to match 'War and Peace'
+      expect(book.pages).to eq 1
+      expect(book.authors).to match_array ['Leo Tolstoy']
+      expect(book.published).to eq Date.parse('1869-01-01')
+      expect(book.sold).to eq Time.new('2015-09-08')
+      expect(book.price).to be_kind_of BigDecimal
+      expect(book.price).to eq 10.00
+      expect(book.format).to eq :paperback
+    end
+  end
+
+  context 'inclusive class with Initializer' do
+    let(:author) { Author.new(name: 'Elliott Mason', age: 30) }
+
+    it { expect(author.name).to match 'Elliott Mason' }
+    it { expect(author.age).to eq 30 }
+  end
+
+  context 'inclusive class with attribute defaults' do
+    let(:reading_progress) { ReadingProgress.new }
+
+    it { expect(reading_progress.page).to eq 1 }
+    it { expect(reading_progress.date).to be_kind_of Time }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'simplecov'
+require 'codeclimate-test-reporter'
+
+formatters = [SimpleCov::Formatter::HTMLFormatter]
+formatters << CodeClimate::TestReporter::Formatter if ENV['TRAVIS']
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[*formatters]
+SimpleCov.start do
+  add_filter '/.bundle'
+  add_filter '/spec'
+end
+
+require 'rspec'
+
+RSpec.configure do |config|
+  config.before(:each) do |example|
+    SimpleCov.command_name(example.location)
+  end
+end
+
+require 'lean-attributes'
+require 'fixtures.rb'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: lean-attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- R. Elliott Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: |
+  lean-attributes allows you to define coerced attributes for Ruby classes
+email:
+- r.elliott.mason@fastmail.fm
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/lean-attributes.rb
+- lib/lean-attributes/attributes.rb
+- lib/lean-attributes/attributes/attribute.rb
+- lib/lean-attributes/attributes/class_methods.rb
+- lib/lean-attributes/attributes/coercion.rb
+- lib/lean-attributes/attributes/initializer.rb
+- lib/lean-attributes/version.rb
+- spec/fixtures.rb
+- spec/lean_attributes_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lleolin/lean-attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Lean attributes for Ruby classes
+test_files:
+- spec/fixtures.rb
+- spec/lean_attributes_spec.rb
+- spec/spec_helper.rb