readonly 0.1.0

data/.travis.yml

@@ -0,0 +1,9 @@
+cache: bundler
+rvm:
+- 2.3.1
+- 2.4.0-preview2
+before_script:
+script: bundle exec rspec
+after_success:
+  - bundle exec codeclimate-test-reporter
+env:

data/.yardopts

@@ -0,0 +1,3 @@
+--protected
+--no-private
+--embed-mixin ClassMethods

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Konstantin Gredeskoul
+
+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,90 @@
+# ReadOnly — Wrap Any Class in a Readonly Proxy
+
+This gem is meant as a fail-safe to guard certain data against
+modification, and to enforce immutability to a certain extent.  
+
+Of course nothing can be completely immutable in ruby, but by using this
+gem, and at the very least, the unintentional mutation of important 
+objects can be prevented.
+
+## Usage
+
+The gem works for any class by asking the user to define which of the methods
+on the original objects can be safely delegated to the object itself,
+and which of the methods (the mutable ones) should not be.
+
+When wrapping a class, one must do three things in the following order:
+
+1. include module `ReadOnly::Proxy`
+2. call class method `safe_methods` and pass an array of symbols
+   representing safe methods of the class that can be delegated
+3. include module `ReadOnly::DelegateSafeMethods`
+
+### Readonly Hash
+
+Gem comes with a built-in example: `ReadOnly::Hash`. It's an example of
+how any class (a `Hash` in this case) can be wrapped by this library to
+create a immutable version.
+
+Below we demonstrate our attempts to write to this class: note that the
+first level key assignment raises `NoMethodError` because `[]=` method
+was not declared as a safe method, and is not delegated.
+
+Second level key returns a regular hash, which can be modified of
+course, but in this case the returned object is a deep copy of the
+original, and while it can be changed, this does not affect the original 
+object.
+
+```ruby
+require 'readonly/hash'
+  
+@writable_hash = { user: { name: 'Konstantin', phone: '555-222-5555' } }
+@readonly_hash = ReadOnly::Hash.new @writable_hash
+
+@readonly_hash[:user][:name] 
+#=> Konstantin
+@readonly_hash[:user][:name] = 'John'
+#=> John 
+@readonly_hash[:user][:name] 
+#=> Konstantin
+
+# Top level actually raises NoMethodError
+@readonly_hash[:user] = [ 1,2,3 ]
+#=> NoMethodError: undefined method `[]=' for {:user=>{:name=>"Konstantin", :phone=>"555-222-5555"}}:ReadOnly::Hash
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'readonly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install readonly
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kigster/readonly.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+require 'yard'
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
+  t.options.unshift('--title', '"ReadOnly — Fast and Scalable "write-time" Simple Feed for Social Networks, with a Redis-based default backend implementation."')
+  t.after = ->() { exec('open doc/index.html') } if RUBY_PLATFORM =~ /darwin/
+end
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "readonly"
+
+# 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

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/readonly.rb

@@ -0,0 +1,20 @@
+require 'readonly/version'
+
+module ReadOnly
+end
+
+Object.class_eval do
+  def deep_dup
+    if respond_to?(:each_with_object)
+      each_with_object(dup) do |(key, value), hash|
+        hash[key.deep_dup] = value.deep_dup
+      end
+    else
+      is_a?(Symbol) ? self : dup
+    end
+  end
+end
+
+require 'readonly/proxy'
+require 'readonly/delegate_safe_methods'
+

data/lib/readonly/delegate_safe_methods.rb

@@ -0,0 +1,13 @@
+module ReadOnly
+  module DelegateSafeMethods
+    def self.included(klass)
+      klass.class_eval do
+        proxied_methods.each do |method|
+          define_method(method) do |*args, &block|
+            @delegate.deep_dup.send(method, *args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/readonly/hash.rb

@@ -0,0 +1,34 @@
+require 'readonly'
+
+module ReadOnly
+  class Hash
+    include ReadOnly::Proxy
+
+    proxied_methods \
+      :[],
+      :each,
+      :each_key,
+      :each_pair,
+      :each_value,
+      :eql?,
+      :has_key?,
+      :has_value?,
+      :inspect,
+      :key,
+      :keys,
+      :length,
+      :select,
+      :size,
+      :to_a,
+      :to_h,
+      :to_hash,
+      :to_s,
+      :value,
+      :value?,
+      :values,
+      :values,
+      :values_at
+
+    include ReadOnly::DelegateSafeMethods
+  end
+end

data/lib/readonly/proxy.rb

@@ -0,0 +1,19 @@
+module ReadOnly
+  module Proxy
+    def self.included(klass)
+      klass.instance_eval do
+        @proxied_methods = []
+        class << self
+          def proxied_methods(*args)
+            @proxied_methods = args if args && !args.empty?
+            @proxied_methods
+          end
+        end
+      end # klass.instance_eval
+    end
+
+    def initialize(writable_object)
+      @delegate = writable_object
+    end
+  end
+end

data/lib/readonly/version.rb

@@ -0,0 +1,3 @@
+module ReadOnly
+  VERSION = '0.1.0'
+end

data/readonly.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readonly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'readonly'
+  spec.version       = ReadOnly::VERSION
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = ['kig@reinvent.one']
+
+  spec.summary       = %q{This gem offers a proxy class that can be used to create a read-only wrappers around any other class, by declaring which methods can be delegated to the wrapped class.}
+  spec.description   = %q{This gem offers a proxy class that can be used to create a read-only wrappers around any other class, by declaring which methods can be delegated to the wrapped class.}
+  spec.homepage      = 'https://github.com/kigster/readonly'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: readonly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: This gem offers a proxy class that can be used to create a read-only
+  wrappers around any other class, by declaring which methods can be delegated to
+  the wrapped class.
+email:
+- kig@reinvent.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/readonly.rb
+- lib/readonly/delegate_safe_methods.rb
+- lib/readonly/hash.rb
+- lib/readonly/proxy.rb
+- lib/readonly/version.rb
+- readonly.gemspec
+homepage: https://github.com/kigster/readonly
+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.6.6
+signing_key: 
+specification_version: 4
+summary: This gem offers a proxy class that can be used to create a read-only wrappers
+  around any other class, by declaring which methods can be delegated to the wrapped
+  class.
+test_files: []