attr_readonly 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06e0134796e7e42dfa0200161011496bda8bb40a
-  data.tar.gz: 767f511807d1ff558bbcc3079dd537dde90ddc0c
+  metadata.gz: 27965629590e66f907071bae9837d1b90b70e03f
+  data.tar.gz: ab2de0b16b3cd2e0e28844408287dbbd9f477b65
 SHA512:
-  metadata.gz: 1867b9539b2028da09d187df96fb782e34abae4b851dc40b1a19de4f5e8ba3fb8841639c2cc1b44633137fb3ba16d9d19d9eff768f2f8bc60f90e8fcc4e0f9be
-  data.tar.gz: 76ec478a356caadd690682bf3ff2d4627a021bb8cc408f2a664ed35f17c2062be4344e79b7ecfb7e2be92281ff117f57f0dcbad384168581ad20c879bbe5784f
+  metadata.gz: e6fcee4acdb5afbb97fd7cb55eb645122343bd12e8eb7502ccd4570a50a1e845046d383bdf674ede81b208a5ec98ae888ec61265a146088c5d66fa7109112bb0
+  data.tar.gz: fbbe277f83bcbd3bd2251d81bc4b126efc3a9eb6eabffcce8b810358c8413a5e54ed67c4140fa3d77df15b35a83b5ffbf27e74c371962b54340f6254cad559e5

data/LICENSE.txt

@@ -1,22 +1,23 @@
-Copyright (c) 2013 Romain GEORGES
+attr_readonly Copyright (c) 2012-2013 Ultragreen Software, Romain GEORGES
+All rights reserved.
 
-MIT License
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
-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.
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -1,6 +1,22 @@
-# AttrReadonly
+# attr_readonly
 
-TODO: Write a gem description
+## Author
+
+ Romain GEORGES <romain@ultragreen.net>
+ Ultragreen Software
+
+## Copyright 
+
+Ultragreen Software (c) 2013
+BSD-2 License 
+
+## Description
+
+Provide a new macro like attr_accessor to make real read_only accessors to frozen dup of the attributs given in parameters
+
+## Version 
+
+   current : 1.0.0
 
 ## Installation
 
@@ -18,7 +34,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem add the macro : attr_readonly to class definition   
+
+You could create reader accessors, in Ruby like :
+
+    class Test 
+      attr_reader :foo
+      def initialize(foo: '')
+        @foo = foo
+      end
+    end       
+
+if you try to do a direct affectation you raise an exception NoMethodError : 
+
+    Test::new.foo= 'bar'    
+    # => undefined method `foo=' for #<Test:0x00000801932598 @foo=""> (NoMethodError)
+   
+But if you try to use a method on this accessor (for exemple <<), you could modify it !
+
+    test = Test::new
+    p test.foo << 'bar'
+    # => "bar"
+    p test
+    # => <Test:0x000008019323b8 @foo="bar">
+    
+if you want to secure an API, or prevent inapriopriate usage of a componant you want to diffuse, this a problem.
+
+So, use this gem, replace the macro attr_reader by attr_readonly :
+
+    require 'attr_readonly'
+    class Test
+      attr_readonly :foo
+      def initialize(foo: '')
+        @foo = foo
+      end
+    end
+
+    Test::new.foo << 'bar'    
+    # => can't modify frozen String (RuntimeError)
+
+No fear, it's just a frozen copy (dup), your real attribut is not frozen
+
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,57 @@
 require "bundler/gem_tasks"
+require 'rubygems'
+require 'rspec'
+require 'rake'
+require "rake/clean"
+require "rubygems/package_task"
+require "rdoc/task"
+require 'code_statistics'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task.rb'
+require "github/markup"
+require "redcarpet"
+require "rake/tasklib"
+require "roodi"
+require "roodi_task"
+
+
+RoodiTask.new() do | t |
+t.patterns = %w(lib/**/*.rb)
+t.config = "ultragreen_roodi_coding_convention.yml"
+end
+
+
+CLEAN.include('*.tmp','*.old')
+CLOBBER.include('*.tmp', 'build/*','#*#')
+
+
+content = File::readlines(File.join(File.dirname(__FILE__), 'attr_readonly.gemspec')).join
+spec = eval(content)
+
+RSpec::Core::RakeTask.new('spec')
+
+
+
+YARD::Rake::YardocTask.new do |t|
+   t.files   = [ 'lib/**/*.rb', '-','doc/**/*','spec/**/*_spec.rb']
+   t.options = %w(--markup-provider=redcarpet --markup=markdown --main=README.md)
+   t.options += ['-o', "yardoc"]	    	
+end
+YARD::Config.load_plugin('yard-rspec')
+
+namespace :yardoc do
+  task :clobber do
+    rm_r "yardoc" rescue nil
+    rm_r ".yardoc" rescue nil
+  end
+end
+task :clobber => "yardoc:clobber"
+
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+task :default => [:gem]

data/attr_readonly.gemspec

@@ -20,4 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('roodi')
+  spec.add_development_dependency('code_statistics')
+  spec.add_development_dependency('yard-rspec')
+  spec.add_development_dependency('github_markup')
+  spec.add_development_dependency('redcarpet')
 end

data/lib/attr_readonly.rb

@@ -1,8 +1,38 @@
-require "attr_readonly/version"
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# Copyright Ultragreen (c) 2012-2�~B013
+#---
+# Author : Romain GEORGES
+# type : gem component library
+# obj : Methodic Module
+#---
+
+# require version is securing for debug
+begin 
+  require "attr_readonly/version"
+rescue LoadError
+  puts 'debug'
+end
 
+# module Methodic
+# @author Romain GEORGES <romain@ultragreen.net>
+# @see http://www.ultragreen.net/projects/attr_reader
+# @version 1.0.0
+# @note this module include a method to be mix in Module (Class)
 module AttrReadonly
 
-
+  
+  # pretty accessor for specifying mandatories options
+  # @param [*Symbol] syms a list of symbols defining accessors to add
+  # @return [Array] Array of symbols methods name (accessors) created
+  # @example usage
+  #    require 'attr_readonly' 
+  #    class Test
+  #      attr_readonly :foo
+  #      def initialize(foo: '')
+  #        @foo = :foo
+  #      end
+  #    end
   def attr_readonly *syms
     syms.each do |method|
       define_method(method){
@@ -14,8 +44,15 @@ module AttrReadonly
 end
 
 
+
+# reimplement Module
+# adding AttrReadonly Mixin for attr_readonly macro
 class Module 
 
+  # include AttrReadonly
   include AttrReadonly
 
 end
+
+
+

data/lib/attr_readonly/version.rb

@@ -1,3 +1,6 @@
+
+
 module AttrReadonly
-  VERSION = "0.0.1"
+  # current version of attr_readonly
+  VERSION = "1.0.0"
 end

data/spec/attr_readonly_spec.rb

@@ -0,0 +1,136 @@
+require './lib/attr_readonly.rb'
+
+describe "Globale Conception" do
+  
+  
+  describe AttrReadonly do
+    subject { AttrReadonly }
+    specify { subject.should be_an_instance_of Module }
+    context "#attr_readonly" do
+      it "should be defined a method call :attr_readonly in the module" do
+        subject.method_defined?(:attr_readonly).should be_true 
+      end
+      it "should accept a variable number of parameters" do 
+        subject.method(:attr_readonly).arity.should == -1
+      end
+    end
+  end
+  
+  
+  describe Module do 
+    subject { Module }
+    specify { subject.should be_an_instance_of Class }
+    it "should include module AttrReadonly" do 
+      subject.include?(AttrReadonly).should be_true
+    end
+    it "should include method :attr_readonly"do 
+      subject.method_defined?(:attr_readonly).should be_true
+    end
+  end
+  
+  
+  describe "Test Class instance" do 
+    
+    before :all do
+      
+      class Test 
+        attr_readonly :array
+        attr_readonly :string
+        attr_readonly :hash
+        def initialize(array: [], hash: {}, string: "")
+          @array = array
+          @hash = hash
+          @string = string
+        end
+      end
+    end 
+    
+    
+    
+    
+    
+    subject { Test::new }
+    specify { subject.should be_an_instance_of Test }
+
+    describe "instance variables" do 
+      it "should be exist @hash with an empty hash" do
+        subject.instance_variable_get('@hash').should == {}
+      end 
+     it "should be exist @array with an empty array" do
+        subject.instance_variable_get('@array').should == []
+      end 
+     it "should be exist @string with an empty string" do
+        subject.instance_variable_get('@string').should == ""
+      end       
+    end
+    describe "Reader accessors" do 
+      it "should include method :array" do 
+        subject.methods.include?(:array).should be_true
+      end
+      it "should include method :string" do 
+        subject.methods.include?(:string).should be_true
+      end
+      it "should include method :hash" do 
+        subject.methods.include?(:hash).should be_true
+      end
+    end
+    describe "No writer accessors" do 
+      it "should not include method :array=" do 
+        subject.methods.include?(:array=).should be_false
+      end
+      it "should not include method :string=" do 
+        subject.methods.include?(:string=).should be_false
+      end
+      it "should not include method :hash=" do 
+        subject.methods.include?(:hash=).should be_false
+      end
+      
+    end
+    describe "initials values for read accessors" do 
+      it "should #hash return an empty hash" do 
+        subject.hash.should == {}
+      end
+      it "should #array return an empty array" do 
+        subject.array.should == [] 
+      end
+      it "should #string return an empty string" do 
+        subject.string.should == ""
+      end
+    end
+ 
+    describe "Attempt to write by attributs object methods" do 
+      it "should raise an exception if trying to write hash[:test] = 'test'" do 
+        lambda {subject.hash[:test] = 'test'}.should raise_error RuntimeError
+        lambda {subject.hash.store(:key,'test')}.should raise_error RuntimeError
+        lambda {subject.hash.merge!({:key => 'test'})}.should raise_error RuntimeError
+      end
+      it "should raise an exception if trying to write array[1] = 'test'" do 
+        lambda {subject.array[1] = 'test'}.should raise_error RuntimeError
+        lambda {subject.array.push('test')}.should raise_error RuntimeError
+      end
+      it "should raise an exception if trying to write string << 'test'" do 
+        lambda {subject.string << 'test' }.should raise_error RuntimeError
+        lambda {subject.string.concat(33)}.should raise_error RuntimeError
+      end
+
+    end
+
+    describe "Getting the instance variable via the accessors could be done, if set by the inside of the Object (simulate via instance_variable_set)" do 
+      it "should #hash return {:test => 'test'}" do 
+        subject.instance_variable_set(:@hash,{:test => 'test'})
+        subject.hash.should == {:test => 'test'}
+      end  
+      it "should #array return [:test]" do 
+        subject.instance_variable_set(:@array,[:test])
+        subject.array.should == [:test]
+      end  
+      it "should #string return 'test'" do 
+        subject.instance_variable_set(:@string,'test')
+        subject.string.should == "test"
+      end  
+    end
+    
+    
+  end
+  
+end

data/spec/init_spec.rb

@@ -0,0 +1 @@
+require "spec_helper"

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+require 'rubygems'
+require 'rspec'
+
+

data/ultragreen_roodi_coding_convention.yml

@@ -0,0 +1,25 @@
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:             
+  line_count: 300
+ClassNameCheck:                  
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+#ClassVariableCheck:
+CyclomaticComplexityBlockCheck:  
+  complexity: 5
+CyclomaticComplexityMethodCheck: 
+  complexity: 10
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:            
+  line_count: 30 
+MethodNameCheck:                 
+  pattern: !ruby/regexp /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ 
+# MissingForeignKeyIndexCheck:
+ModuleLineCountCheck:            
+  line_count: 500
+ModuleNameCheck:          
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:            
+  parameter_count: 5
+ 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_readonly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Romain GEORGES
@@ -38,6 +38,118 @@ dependencies:
     - - '>='
       - !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: 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: rdoc
+  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: roodi
+  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: code_statistics
+  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: yard-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: github_markup
+  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: redcarpet
+  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: Provide a new macro like attr_accessor to make real read_only accessors
   to frozen dup of the attributs given in parameters
 email:
@@ -54,6 +166,10 @@ files:
 - attr_readonly.gemspec
 - lib/attr_readonly.rb
 - lib/attr_readonly/version.rb
+- spec/attr_readonly_spec.rb
+- spec/init_spec.rb
+- spec/spec_helper.rb
+- ultragreen_roodi_coding_convention.yml
 homepage: ''
 licenses:
 - BSD
@@ -78,4 +194,7 @@ rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Provide a new macro like attr_accessor to make real read_only accessors
-test_files: []
+test_files:
+- spec/attr_readonly_spec.rb
+- spec/init_spec.rb
+- spec/spec_helper.rb