fluent_accessors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 527b4fe77875ef004cd143dfe5faa826fbb94366
+  data.tar.gz: d7e5b16b0e70f877cf6523b0874181aea18d5737
+SHA512:
+  metadata.gz: a59dc662cb657633b9c8a5cfd05d699db7493b1fa23c04db06ab4bf2493249101d3a471ad1b43d98d4dcb792a27f0ee2be264fb13ccaee2513c46bd0b5ba182c
+  data.tar.gz: 0b058c12dc332ef237b18e82472934d477503ad437e5f0c3b0a16a18fa989a8546326bb665ad34842bcce71204d97c94263d3800ba8add907ff161eefbff7097

data/.gitignore

@@ -0,0 +1,57 @@
+.idea
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache: bundler
+
+addons:
+  code_climate:
+    repo_token: 672fdd75b2f1fff020629c07108bf49cffc8fe716c73bc7ca5758dc3eb5124bd
+
+
+rvm:
+  - 2.1.1
+  - 2.0.0
+
+script: 'bundle exec rake spec'
+
+notifications:
+  email:
+    recipients:
+      - eturino@eturino.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent_accessors.gemspec
+gemspec
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eduardo Turiño
+
+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,95 @@
+# FluentAccessors
+
+Adds class method `fluent_accessor` which will create several methods to enable fluent API access to the instance variables.
+
+## Dependencies
+
+it requires Ruby 2, since it uses keyword arguments
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent_accessors'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent_accessors
+
+## Usage
+
+### Basic usage
+
+```ruby
+class TestKlass
+  extend FluentAccessors
+  fluent_accessor :something
+end
+
+x = TestKlass.new
+
+# normal setter
+x.something = 1
+
+# normal getter
+x.something # => 1
+
+# fluent setter method
+x.set_something 2 # returns self
+x.something # => 2
+
+# using getter with argument => fluent method
+x.something 3 # returns self
+x.something # => 3
+```
+
+### fluent method
+
+the Fluent method (getter with an argument) will:
+
+1. always return `self`
+2. it will *not* set the value directly:
+  a. if the object responds to a `set_myproperty` method, it will call that and assume that it will
+  b. if the object does not respond to a `set_myproperty` method, it will call the normal setter `myproperty=`
+  c. if the object does not respond to a `set_my_property` nor `myproperty=` methods, it will set the property directly.
+
+### avoiding set_something method
+
+if you don't want the `set_something` method, you can specify not to create it.
+
+```ruby
+class TestKlass
+  extend FluentAccessors
+  fluent_accessor :something, set_method: false
+end
+
+x = TestKlass.new
+s.respond_to? :set_method # => false
+```
+
+### avoiding creating the writer method
+
+if you don't want the `something=` method, you can specify not to create it.
+
+```ruby
+class TestKlass
+  extend FluentAccessors
+  fluent_accessor :something, writer_method: false
+end
+
+x = TestKlass.new
+s.respond_to? :something= # => false
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/eturino/fluent_accessors/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,11 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec
+

data/fluent_accessors.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fluent_accessors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent_accessors"
+  spec.version       = FluentAccessors::VERSION
+  spec.authors       = ["Eduardo Turiño"]
+  spec.email         = ["(none)"]
+  spec.summary       = %q{Gem that provides a macro for creating fluent accessors for instance variables, working similar to attr_accessor}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "pry-rescue"
+  spec.add_development_dependency "pry-stack_explorer"
+  spec.add_development_dependency "pry-doc"
+
+end

data/lib/fluent_accessors.rb

@@ -0,0 +1,71 @@
+require "fluent_accessors/version"
+
+module FluentAccessors
+  def fluent_accessor(*fields, set_method: true, writer_method: true)
+    Runner.new(self, fields, set_method, writer_method).call
+  end
+
+  class Runner
+    attr_reader :klass, :fields, :setter_enabled, :writer_enabled
+
+    def initialize(klass, fields, setter_enabled, writer_enabled)
+      @klass          = klass
+      @fields         = fields
+      @setter_enabled = setter_enabled
+      @writer_enabled = writer_enabled
+    end
+
+    def call
+      create_writer
+      fields.each do |field|
+        deal_with_field(field)
+      end
+    end
+
+    private
+    def create_writer
+      if writer_enabled
+        klass.send :attr_writer, *fields
+      end
+    end
+
+    def deal_with_field(field)
+      getter        = field
+      normal_setter = "#{field}="
+      fluent_setter = "set_#{field}"
+      instance_var  = "@#{field}"
+
+      create_setter(fluent_setter, normal_setter)
+      create_fluent(fluent_setter, getter, instance_var, normal_setter)
+    end
+
+    def create_fluent(fluent_setter, getter, instance_var, normal_setter)
+      klass.send :define_method, getter do |*args, &block|
+        if args.empty?
+          instance_variable_get instance_var
+        else
+          if respond_to? fluent_setter
+            send fluent_setter, *args, &block
+          elsif respond_to? normal_setter
+            send normal_setter, *args, &block
+          else
+            instance_variable_set instance_var, args.first
+          end
+
+          self
+        end
+      end
+    end
+
+    def create_setter(fluent_setter, normal_setter)
+      if setter_enabled
+        # fluent setter that calls the normal setter and returns self
+        klass.send :define_method, fluent_setter do |value, &block|
+          send normal_setter, value, &block
+          self
+        end
+      end
+    end
+
+  end
+end

data/lib/fluent_accessors/version.rb

@@ -0,0 +1,3 @@
+module FluentAccessors
+  VERSION = "1.0.0"
+end

data/spec/fluent_accessors_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+RSpec.describe FluentAccessors do
+
+  class FluentAccessorsTestKlass
+    extend FluentAccessors
+    fluent_accessor :something
+    fluent_accessor :other, set_method: false
+    fluent_accessor :another, set_method: false
+    fluent_accessor :no_writer, writer_method: false, set_method: false
+
+    def initialize(something, other, another)
+      @something = something
+      @other     = other
+      @another   = another
+    end
+
+    def set_another(value)
+      @set_called = true
+
+      @another = value
+      :return_of_set_another
+    end
+
+    def setter_called?
+      !!@set_called
+    end
+  end
+
+  describe FluentAccessorsTestKlass do
+    subject { described_class.new :hey, :you, :there }
+    describe '#something (fluent setter/getter)' do
+      describe '#something as getter' do
+        it 'return the value' do
+          expect(subject.something).to eq :hey
+        end
+      end
+
+      describe '#something("val")' do
+        it 'set the value and return self' do
+          res = subject.something :x
+          expect(subject).to be res
+          expect(subject.something).to eq :x
+        end
+      end
+
+      describe '#set_something("val")' do
+        it 'set the value and return self' do
+          res = subject.set_something :x
+          expect(subject).to be res
+          expect(subject.something).to eq :x
+        end
+      end
+    end
+
+    context 'without fluent setter' do
+      describe '#set_other("val")' do
+        it 'does not have the method' do
+          expect(subject).not_to respond_to :set_other
+        end
+      end
+
+      describe '#other("val") (fluent setter)' do
+        it 'set the value and return self' do
+          res = subject.other :x
+          expect(subject).to be res
+          expect(subject.other).to eq :x
+        end
+      end
+    end
+
+    context 'without fluent setter, but with a different set_x method ' do
+      describe '#another("val") (fluent setter)' do
+        it '(call set_another) and return self, regardless of what set_another returns' do
+          res = subject.another :x
+          expect(subject).to be res
+          expect(subject.another).to eq :x
+          expect(subject).to be_setter_called
+        end
+      end
+    end
+
+    context 'without writer setter' do
+      describe '#no_writer("val") (fluent setter)' do
+        it 'sets the instance variable the and return self' do
+          # check that it works with arrays
+          res = subject.no_writer [:x]
+          expect(subject).to be res
+          expect(subject.no_writer).to eq [:x]
+        end
+
+        it 'does not have the setter' do
+          expect(subject).not_to respond_to :no_writer=
+          expect(subject).not_to respond_to :set_writer
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'pry'
+require 'fluent_accessors'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: fluent_accessors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eduardo Turiño
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- "(none)"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent_accessors.gemspec
+- lib/fluent_accessors.rb
+- lib/fluent_accessors/version.rb
+- spec/fluent_accessors_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Gem that provides a macro for creating fluent accessors for instance variables,
+  working similar to attr_accessor
+test_files:
+- spec/fluent_accessors_spec.rb
+- spec/spec_helper.rb
+has_rdoc: