restricted_struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 701f39867ce9703612900fe3fc7a02a5546860cd
+  data.tar.gz: ec33a9f1adf85537047831ad5f52c7d02be8bc1f
+SHA512:
+  metadata.gz: 97fc5cf511d82388464d41532d3f41a063de18b89891c1c9ac5cbd728e2337e2dc6ce2825dbe156350a65c59ba66eee5dffdb1a2d627d13d195c9ba75e5a4b9c
+  data.tar.gz: 96fa0f60b0005d2ff5da42137de9bcb8973bafe88e117854209fc532c2db24adb29f89970101f3128bce0a1058062bc0094f8f2dc9b965f95cae0e4bf3d2205b

data/.gitignore

@@ -0,0 +1,14 @@
+/.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/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx
+
+script: bundle exec rspec
+bundler_args: --without development

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in restricted_struct.gemspec
+gemspec
+
+gem "rspec"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alexey Fedorov
+
+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,56 @@
+# RestrictedStruct
+
+[![Build Status](https://travis-ci.org/waterlink/restricted_struct.svg?branch=master)](https://travis-ci.org/waterlink/restricted_struct)
+
+This gem allows to use ruby's Struct, but automatically hides all the attributes as private or protected, which provides higher level of encapsulation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restricted_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restricted_struct
+
+## Usage
+
+Instead of doing this:
+
+```ruby
+class Rectangle < Struct.new(:x1, :y1, :x2, :y2)
+  protected :x1, :x1=, :y1, :y1=, :x2, :x2=, :y2, :y2=
+
+  # ...
+end
+```
+
+one can do:
+
+```ruby
+class Rectangle < RestrictedStruct.new(:protected, :x1, :y1, :x2, :y2)
+  # ...
+end
+```
+
+Available access levels: `:private` and `:protected`.
+
+## Contributing
+
+1. Fork it ( https://github.com/waterlink/restricted_struct/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
+
+## Contributors
+
+- [Alexey Fedorov](https://github.com/waterlink)
+- [Anselm Helbig](https://github.com/anselm-helbig-wimdu)

data/Rakefile

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

data/lib/restricted_struct/definition.rb

@@ -0,0 +1,29 @@
+class RestrictedStruct < Struct
+  ACCESS_RESTRICTIONS = {
+    :private => lambda { |methods| lambda { |*| private *methods } },
+    :protected => lambda { |methods| lambda { |*| protected *methods } }
+  }
+  ACCESS_LEVELS = ACCESS_RESTRICTIONS.keys
+
+  class << self
+    def new(access_level, *properties)
+      super(*properties, &access_restriction(access_level, properties))
+    end
+
+    private
+
+    def access_restriction(access_level, properties)
+      builder_strategy(access_level).call(accessor_methods(properties))
+    end
+
+    def builder_strategy(access_level)
+      ACCESS_RESTRICTIONS.fetch(access_level) do
+        raise ArgumentError, "access_level can be only one of #{ACCESS_LEVELS}"
+      end
+    end
+
+    def accessor_methods(properties)
+      properties + properties.map { |name| :"#{name}=" }
+    end
+  end
+end

data/lib/restricted_struct/version.rb

@@ -0,0 +1 @@
+RestrictedStruct::VERSION = "0.1.0"

data/lib/restricted_struct.rb

@@ -0,0 +1,2 @@
+require "restricted_struct/definition"
+require "restricted_struct/version"

data/restricted_struct.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restricted_struct'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restricted_struct"
+  spec.version       = RestrictedStruct::VERSION
+  spec.authors       = ["Alexey Fedorov", "Anselm Helbig"]
+  spec.email         = ["alexey.fedorov@wimdu.com", "anselm.helbig@wimdu.com"]
+  spec.summary       = %q{Create Struct-s with private or protected attributes}
+  spec.description   = %q{This gem allows to use ruby's Struct, but automatically hides all the attributes as private or protected, which provides higher level of encapsulation.}
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/restricted_struct_spec.rb

@@ -0,0 +1,26 @@
+RSpec.describe RestrictedStruct do
+  it "validates access_level" do
+    expect {
+      described_class.new(:invalid, :some, :properties)
+    }.to raise_error(ArgumentError)
+  end
+
+  described_class::ACCESS_LEVELS.each do |access_level|
+    context "when creating #{access_level} struct" do
+      subject { described_class.new(access_level, :some, :properties) }
+
+      it "makes readers #{access_level}" do
+        expect {
+          subject.new("some", "value").some
+        }.to raise_error(NoMethodError, /#{access_level} method `some'/)
+      end
+
+      it "makes writers #{access_level}" do
+        expect {
+          subject.new("some", "value").properties = 42
+        }.to raise_error(NoMethodError, /#{access_level} method `properties='/)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require "restricted_struct"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: restricted_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Fedorov
+- Anselm Helbig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 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'
+description: This gem allows to use ruby's Struct, but automatically hides all the
+  attributes as private or protected, which provides higher level of encapsulation.
+email:
+- alexey.fedorov@wimdu.com
+- anselm.helbig@wimdu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/restricted_struct.rb
+- lib/restricted_struct/definition.rb
+- lib/restricted_struct/version.rb
+- restricted_struct.gemspec
+- spec/restricted_struct_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: Create Struct-s with private or protected attributes
+test_files:
+- spec/restricted_struct_spec.rb
+- spec/spec_helper.rb