simple_attrs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c511452b534540bc99df27d27f5ee2817910a860
+  data.tar.gz: e106a056b408c021f4f7e63d44368d883adb4d8c
+SHA512:
+  metadata.gz: 5f9a70e3875a36b2f5783aec75d45c82c28410c4e6bb60957eae7e9f535f8ad8d5e72163192fe613487409c49272a05ae2117f935828a1b400e260ce1e23281d
+  data.tar.gz: 4dd8a3b9c51db099363c6c0efc21adef0613c89ccbeb20e5e7b7b6627ef46765316b8d1e45c0c58ae39e090a061f5962a382810e25ae665523981bcbfcd51276

data/.gitignore

@@ -0,0 +1,15 @@
+.gems/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_attrs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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,60 @@
+# SimpleAttrs
+
+The goal is to provide a simple DSL to define attributes for your
+models.
+
+## Features
+- Adds a reader/write for each attribute using `attr_accessor`.
+- Adds an initializer that takes in an options hash to define intial
+  values.  The default initializer will ensure that the option hash only
+includes values defined as a simple_attr.
+
+SimpleAttrs does not support type checking, coercion or default
+values.  For a more complex solution, look at these other great
+libraries: [Attrs](https://github.com/wojtekmach/attrs),
+[Attrio](https://github.com/jetrockets/attrio), [Virtus](https://github.com/solnic/virtus)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_attrs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_attrs
+
+## Usage
+
+```ruby
+require 'simple_attrs'
+
+class SimpleExample
+  include SimpleAttrs
+
+  has_simple_attr :attr1
+  has_simple_attr :attr2
+  has_simple_attr :attr3
+end
+
+ex = SimpleExample.new(attr1: 1, attr2: 2)
+ex.attributes
+=> { attr1: 1, attr2: 2, attr3: nil }
+
+ex = SimpleExample.new(invalid_attr: 1)
+ArgumentError: Cannot set invalid_attr through initializer
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/codeshoppe/simple_attrs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/simple_attrs.rb

@@ -0,0 +1,39 @@
+require "simple_attrs/version"
+
+module SimpleAttrs
+  def self.included(base)
+    base.extend ClassMethods
+
+    base.class_eval do
+      @simple_attrs ||= {}
+
+      def initialize(options = {})
+        options.each do |key, value|
+          if self.class.simple_attrs.has_key?(key.to_sym)
+            instance_variable_set("@#{key}", value)
+          else
+            raise ArgumentError, "Cannot set #{key} through initializer"
+          end
+        end
+      end
+
+      def attributes
+        self.class.simple_attrs.inject({}) do |result, attr_pair|
+          key, _value = attr_pair
+          result.merge(key => self.public_send(key))
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+    def has_simple_attr(attr_name)
+      @simple_attrs[attr_name.to_sym] = nil
+      attr_accessor attr_name
+    end
+
+    def simple_attrs
+      @simple_attrs
+    end
+  end
+end

data/lib/simple_attrs/version.rb

@@ -0,0 +1,3 @@
+module SimpleAttrs
+  VERSION = "0.0.1"
+end

data/simple_attrs.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_attrs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_attrs"
+  spec.version       = SimpleAttrs::VERSION
+  spec.authors       = ["Jennifer Reyes"]
+  spec.email         = ["jgdreyes@gmail.com"]
+  spec.summary       = %q{Simple attrs DSL}
+  spec.description   = %q{DSL for adding attributes to any plain old ruby object.}
+  spec.homepage      = "http://codeshoppe.github.io/simple_attrs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "byebug", "~> 3.5"
+end

data/spec/lib/simple_attrs_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe SimpleAttrs do
+  context 'setting an attribute' do
+    let(:klass) { Class.new { include SimpleAttrs } }
+
+    it 'defines a reader' do
+      klass.has_simple_attr(:valid_attr)
+      instance = klass.new
+      expect(instance).to respond_to("valid_attr")
+    end
+
+    it 'defines a writer' do
+      klass.has_simple_attr(:valid_attr)
+      instance = klass.new
+      expect(instance).to respond_to("valid_attr=")
+    end
+  end
+
+  context '#intialize' do
+    let(:klass) { Class.new { include SimpleAttrs } }
+    let(:klass_with_custom_initialize) do
+      Class.new {
+        include SimpleAttrs
+        has_simple_attr :valid_attr
+        def initialize(some_value)
+          @some_value = some_value
+        end
+      }
+    end
+
+    it 'defines an instance variable' do
+      klass.has_simple_attr(:valid_attr)
+      instance = klass.new(valid_attr: 3)
+      expect(instance).to be_instance_variable_defined(:@valid_attr)
+    end
+
+    it 'sets the value of the attribute' do
+      klass.has_simple_attr(:valid_attr)
+      instance = klass.new(valid_attr: 3)
+      expect(instance.valid_attr).to eq(3)
+    end
+
+    it 'raises error when trying to initialize non simple attr' do
+      klass.has_simple_attr(:valid_attr)
+      expect {
+        klass.new(valid_attr: 3, invalid_attr: 4)
+      }.to raise_error(ArgumentError, "Cannot set invalid_attr through initializer")
+    end
+
+    it 'allows for initialize to be overwritten' do
+      expect {
+        klass_with_custom_initialize.new(3)
+      }.not_to raise_error
+    end
+
+    it 'allows for initialize to be overwritten' do
+      expect {
+        klass_with_custom_initialize.new(3)
+      }.not_to raise_error
+    end
+  end
+
+  describe '#attributes' do
+    let(:klass) do
+      Class.new {
+        include SimpleAttrs
+        attr_accessor :some_other_attr
+      }
+    end
+
+    it 'returns all simple_attr attributes' do
+      klass.has_simple_attr(:valid_attr1)
+      klass.has_simple_attr(:valid_attr2)
+
+      instance = klass.new(valid_attr1: 'test')
+      expect(instance.attributes).to eq({valid_attr1: 'test', valid_attr2: nil})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+require 'simple_attrs'
+require 'byebug'
+
+RSpec.configure do |config|
+  config.order = :random
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: simple_attrs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jennifer Reyes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: DSL for adding attributes to any plain old ruby object.
+email:
+- jgdreyes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_attrs.rb
+- lib/simple_attrs/version.rb
+- simple_attrs.gemspec
+- spec/lib/simple_attrs_spec.rb
+- spec/spec_helper.rb
+homepage: http://codeshoppe.github.io/simple_attrs
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple attrs DSL
+test_files:
+- spec/lib/simple_attrs_spec.rb
+- spec/spec_helper.rb