coati 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTQ5ZDNkZTE5OGUxNGZlZDU1ZjExMGNiZjE2NjY5M2VjMWU4YmI5Ng==
+  data.tar.gz: !binary |-
+    MmJiYjg1OGU4NGU0NGVjZmVmZWY0ODE1ZDlkY2JiODc4MTQ3MzZjOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjI2Yzc1OTEwZWVjOTg2ZDMzZTM1NjE1YmUxNDU3NThlNzVhNjcwZTA0ODRj
+    NWU4NDRhOTRkYTQwNjg3N2IwOTRjYjliYWM2N2YwNTI5MTQ2NzdjZmY2NGFj
+    NTc5M2M2NGM1NTY5MjE4Y2U3YjAxOWNkNTcyOTQ3ZTRjMTU0Mzg=
+  data.tar.gz: !binary |-
+    NWIyNWM0NjI5NjY2YTcwYzhkZTUwYjRhN2NlM2JiOTAxZTI1NTBkZjJmN2U3
+    NmEzOTU0OWE1MjE1ZDM5NDUxMWM4OGY2MWU2YzkyZGEyNjdjMmVkNDE3MjM4
+    ODUyZDQwZDIyNjI5ZmJjMWYxZWZhZjZhMWRmMGQ5NTFkYzNiY2Q=

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    coati (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coati!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Albert Bellonch Llargués
+
+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,55 @@
+Coati
+======
+
+Description
+-----------
+
+Coati hides user-defined instance variables from being show when inspecting an instance of the class.
+
+Imagine you have a simple class like:
+
+    class TestClass
+      def initialize(username, password)
+        @username = username
+        @password = password
+      end
+    end
+
+Then when you inspect the instance of the class, the output will be something like:
+
+    [1] pry(main)> instance = TestClass.new('Joe', 'supersecretpassword')
+    => #<TestClass:0x007f9633ca87f0 @username="Joe", @password="supersecretpassword">
+
+...even if we don't want the password value to be shown. This gem addresses this problem.
+
+This gem is named after [an American mammal](https://en.wikipedia.org/wiki/Coati).
+
+Installation
+------------
+
+Simply do
+
+    gem install coati
+
+Usage
+------------
+
+Firstly require it from the file:
+
+    require 'coati'
+
+Then use the `attr_hider` method in the class:
+
+    class TestClass
+      attr_hider :password
+
+      def initialize(username, password)
+        @username = username
+        @password = password
+      end
+    end
+
+When inspecting an instance of the class, the ouput will be something like:
+
+    [1] pry(main)> instance = TestClass.new('Joe', 'supersecretpassword')
+    => #<TestClass:0x007f9633ca87f0 @username="Joe">

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "okapi"
+  gem.homepage = "http://github.com/albertbellonch/okapi"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "albert@itnig.net"
+  gem.authors = ["Albert Bellonch Llargués"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "okapi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/coati.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "coati/version"
+
+Gem::Specification.new do |s|
+  s.name        = "coati"
+  s.version     = Coati::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Albert Bellonch"]
+  s.email       = ["albert@itnig.net"]
+  s.homepage    = "http://github.com/albertbellonch/coati"
+  s.summary     = %q{ A simple utility that hides instance variables inside Ruby objects }
+
+  s.rubyforge_project = "coati"
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/lib/coati.rb

@@ -0,0 +1 @@
+require 'coati/core'

data/lib/coati/core.rb

@@ -0,0 +1,26 @@
+module Coati
+  module ClassMethods
+    def attr_hider(*attrs)
+      define_method :attrs_to_hide do
+        attrs
+      end
+    end
+  end
+
+  module InstanceMethods
+    def inspect
+      new_inspect = super
+
+      if self.class.instance_methods.include?(:attrs_to_hide)
+        attrs_to_hide.each do |attr_to_hide|
+          new_inspect.gsub!(/,? @#{attr_to_hide}=".+"/, '')
+        end
+      end
+
+      new_inspect
+    end
+  end
+end
+
+Object.extend Coati::ClassMethods
+Object.send(:include, Coati::InstanceMethods)

data/lib/coati/version.rb

@@ -0,0 +1,3 @@
+module Coati
+  VERSION = "0.1.0"
+end

data/spec/integration/coati.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'coati'
+
+describe Coati do
+  class TestClass
+    attr_hider :password
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+  end
+
+  before do
+    @instance = TestClass.new('myusername', 'mypassword')
+    @inspect = @instance.inspect
+  end
+
+  it "should show the name and value of the username" do
+    @inspect.should =~ /@username=\"myusername\"/
+  end
+
+  it "should not show the name neither the value of the username" do
+    @inspect.should_not =~ /@password=\"mypassword\"/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'coati'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: coati
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Albert Bellonch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- albert@itnig.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- coati.gemspec
+- lib/coati.rb
+- lib/coati/core.rb
+- lib/coati/version.rb
+- spec/.DS_Store
+- spec/integration/coati.rb
+- spec/spec_helper.rb
+homepage: http://github.com/albertbellonch/coati
+licenses: []
+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: coati
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple utility that hides instance variables inside Ruby objects
+test_files:
+- spec/integration/coati.rb
+- spec/spec_helper.rb