private_attrs 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fb676e3a2421949cc5239dbfaa58ac40fb923d3
+  data.tar.gz: 1861e9c782a3ddf2b5305272909a97cec6466a64
+SHA512:
+  metadata.gz: 1bbd4825cc9b1639bf6bc0a70c32e83214fa8bc91e9d575c60b4e4406ee5fb6ce7bc83f140859bd874776fa6c2d0e4f35c39f77919ae524369c7c74c46c7bd28
+  data.tar.gz: 0dc6a09deb3a24a3f54f0297180cc1a34017a112cbe17b48cb7fb98a0923948ac6013913d018c922f1c29a1f39f87191a245d19b2d69e5be1639908e8cd46e30

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in private_attrs.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    private_attrs (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  private_attrs!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zach Colon
+
+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,128 @@
+# PrivateAttrs
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/09bf301b78287db6e51b/maintainability)](https://codeclimate.com/github/wzcolon/private_attrs/maintainability)
+
+Adds a few to Ruby's Clss object to allow for private attr
+readers/writers/accessors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'private_attrs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install private_attrs
+
+## Usage
+
+Inside any class object you can now define private attr methods.
+
+```
+class Crocodile
+
+  private_attr_reader :temper
+
+  def intialize(temper)
+    @temper = temper
+  end
+end
+
+Crocodile.new('angry').temper # => NoMethodError "private method 'temper' called for ...
+```
+
+### Why
+
+In short, because existing patterns to do this are ugly. This particular
+pattern violates 'the scissor rule' of coding in that there is not a clear
+separation between public and private methods.
+
+
+```
+class Crocodile
+
+  private
+
+  attr_reader :temper
+
+  public
+
+  attr_reader :asleep
+
+  def initialize(temper)
+    @temper = temper
+  end
+
+  def bites?
+    if angry? && !asleep?
+  end
+
+  private
+
+  def angry?
+    temper == 'angry'
+  end
+
+  def asleep?
+    current_time = Time.now
+    (current_time.hour >= 17) and (current_time.hour <= 21)
+  end
+end
+```
+
+This use case is better but still not ideal as we want all of our attrs
+methods definded at the top of any given class.
+
+```
+class Truck
+
+  attr_reader :transmission_type
+  attr_reader :weight
+
+  def initialize(wheel_count:, transmission_type:, weight:)
+    @wheel_count = wheel_count
+    @transmission_type = transmission_type
+    @weight =  weight
+  end
+
+  def oversized
+    wheel_count > 4
+  end
+
+  def driver_must_shift?
+    transmission_type == :manual
+  end
+
+  private
+
+  attr_reader :wheel_count
+end
+```
+
+Other patterns are even worse...
+```
+class Pet
+
+  attr_accessor :species
+  private :species
+  private :species=
+
+  attr_reader :hairy
+  private :hairy
+
+  def initialize(species, hairy)
+    #...
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "private_attrs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/private_attrs/attr_methods.rb

@@ -0,0 +1,29 @@
+module AttrMethods
+  def self.included(base)
+    base.class_eval do
+      def self.private_attr_reader(*args)
+        args.each do |arg|
+          private
+          attr_reader arg.to_sym
+          public
+        end
+      end
+
+      def self.private_attr_writer(*args)
+        private
+        args.each do |arg|
+          attr_writer arg.to_sym
+        end
+        public
+      end
+
+      def self.private_attr_accessor(*args)
+        private
+        args.each do |arg|
+          attr_accessor arg.to_sym
+        end
+        public
+      end
+    end
+  end
+end

data/lib/private_attrs/config.rb

@@ -0,0 +1,7 @@
+module PrivateAttrs
+  class Config
+    def self.add_private_attrs!
+      self.superclass.send(:include, AttrMethods)
+    end
+  end
+end

data/lib/private_attrs/version.rb

@@ -0,0 +1,3 @@
+module PrivateAttrs
+  VERSION = "0.1.1"
+end

data/lib/private_attrs.rb

@@ -0,0 +1,7 @@
+require 'private_attrs/version'
+require 'private_attrs/config'
+require 'private_attrs/attr_methods'
+
+module PrivateAttrs
+  PrivateAttrs::Config.add_private_attrs!
+end

data/private_attrs.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "private_attrs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "private_attrs"
+  spec.version       = PrivateAttrs::VERSION
+  spec.authors       = ["Zach Colon"]
+  spec.email         = ["zcolon80@gmail.com"]
+
+  spec.summary       = %q{Adds private attr methods to Class object}
+  spec.description   = %q{Adds private attr methods to Class object}
+  spec.homepage      = "https://github.com/wzcolon/private_attrs"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: private_attrs
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Zach Colon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Adds private attr methods to Class object
+email:
+- zcolon80@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/private_attrs.rb
+- lib/private_attrs/attr_methods.rb
+- lib/private_attrs/config.rb
+- lib/private_attrs/version.rb
+- private_attrs.gemspec
+homepage: https://github.com/wzcolon/private_attrs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Adds private attr methods to Class object
+test_files: []