accessor_utilities 1.0.0

data/README.md

@@ -0,0 +1,105 @@
+# Accessor Utilities #
+
+http://rubygems.org/gems/accessor_utilities
+
+# Description #
+
+Utility methods for accessor-related meta-programming.
+
+# Summary #
+
+Extends String and Symbol instances with variable/accessor methods, provides swizzling helpers, provides accessor-related math for transforming :accessor, :reader, :writer.
+
+## AccessorUtilities::AccessorMath ##
+
+Given attribute accessor types :accessor, :reader, :writer:
+
+### :status_plus_other_status ###
+
+* status_plus_other_status( :accessor, :reader ) = :accessor
+* status_plus_other_status( :accessor, :writer ) = :accessor
+* status_plus_other_status( :reader, :writer ) = :accessor
+* status_plus_other_status( :reader, :reader ) = :reader
+
+### :status_minus_other_status ###
+
+* status_minus_other_status( :accessor, :reader ) = :writer
+* status_minus_other_status( :accessor, :writer ) = :reader
+* status_minus_other_status( :reader, :writer ) = :reader
+* status_minus_other_status( :reader, :reader ) = nil
+
+## AccessorUtilities::Swizzle ##
+
+Given a class with a method defined:
+
+```ruby
+class ExampleClass
+
+  def some_method
+    return :first_value
+  end
+
+end
+```
+
+Swizzle methods within the present context:
+
+```ruby
+class ExampleClass
+
+  include AccessorUtilities::Swizzle
+
+  swizzle_method( :some_method ) do
+    :second_value
+  end
+
+end
+```
+
+Result is method call invokes block used to swizzle method:
+
+```ruby
+class ExampleClass
+
+  self.some_method
+  # => :second_value
+
+end
+```
+
+## AccessorUtilities::StringInstance and AccessorUtilities::SymbolInstance ##
+
+* is_variable_name?
+* variable_name
+* accessor_name
+* write_accessor_name
+* swizzle_name
+
+# Install #
+
+* sudo gem install accessor_utilities
+
+# License #
+
+  (The MIT License)
+
+  Copyright (c) 2012 Ridiculous Power, Asher
+
+  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/lib/accessor_utilities.rb

@@ -0,0 +1,18 @@
+
+# namespaces that have to be declared ahead of time for proper load order
+require_relative './namespaces'
+
+# source file requires
+require_relative './requires.rb'
+
+class ::Object
+	include ::AccessorUtilities::ObjectInstance
+end
+
+class ::String
+	include ::AccessorUtilities::StringInstance
+end
+
+class ::Symbol
+	include ::AccessorUtilities::SymbolInstance
+end

data/lib/accessor_utilities/accessor_math.rb

@@ -0,0 +1,93 @@
+
+module ::AccessorUtilities::AccessorMath
+
+  ##############################
+  #  status_plus_other_status  #
+  ##############################
+  
+  def status_plus_other_status( existing_status, other_status )
+    
+    status = nil
+    
+    case existing_status
+      
+      when :accessor
+
+        status = :accessor
+
+      when :reader
+
+        case other_status
+          when :writer, :accessor
+            status = :accessor
+          else
+            status = :reader
+        end
+
+      when :writer
+
+        case other_status
+          when :reader, :accessor
+            status = :accessor
+          else
+            status = :writer
+        end
+        
+      when nil
+        
+        return other_status
+      
+    end
+    
+    return status
+    
+  end
+
+  ###############################
+  #  status_minus_other_status  #
+  ###############################
+  
+  def status_minus_other_status( existing_status, other_status )
+    
+    status = nil
+    
+    case existing_status
+      
+      when :accessor
+
+        case other_status
+          when :accessor
+            status = nil
+          when :reader
+            status = :writer
+          when :writer
+            status = :reader
+          else
+            status = :accessor
+        end
+
+      when :reader
+
+        case other_status
+          when :reader, :accessor
+            status = nil
+          else
+            status = :reader
+        end
+
+      when :writer
+
+        case other_status
+          when :writer, :accessor
+            status = nil
+          else
+            status = :writer
+        end
+      
+    end
+    
+    return status
+    
+  end
+	
+end

data/lib/accessor_utilities/object_instance.rb

@@ -0,0 +1,14 @@
+
+module ::AccessorUtilities::ObjectInstance
+
+	#####################################
+	#  instance_variables_as_accessors  #
+	#####################################
+
+	def instance_variables_as_accessors
+
+	  return instance_variables.collect { |this_var| this_var.accessor_name }
+
+	end
+
+end

data/lib/accessor_utilities/string_instance.rb

@@ -0,0 +1,49 @@
+
+module ::AccessorUtilities::StringInstance
+
+	#######################
+	#  is_variable_name?  #
+	#######################
+
+	def is_variable_name?
+    return self[ 0 ] == '@'
+	end
+
+	###################
+	#  variable_name  #
+	###################
+
+	def variable_name
+	  return ( is_variable_name? ? to_sym : ( '@' + self ).to_sym )
+	end
+	
+	###################
+	#  accessor_name  #
+	###################
+
+	def accessor_name
+	  return ( is_variable_name? ? self.slice( 1, length ).to_sym : to_sym )
+	end
+
+	#########################
+	#  write_accessor_name  #
+	#########################
+
+	def write_accessor_name
+	  return ( self[ length - 1 ] == '=' ? to_sym : ( self + '=' ).to_sym )
+	end
+
+	##################
+	#  swizzle_name  #
+	##################
+
+	def swizzle_name( swizzled_method_prefix = 'swizzled__', append_equals_to_method_name = false )
+
+		swizzled_method_name = ( swizzled_method_prefix.to_s + to_s )
+		swizzled_method_name = swizzled_method_name.write_accessor_name if append_equals_to_method_name
+
+	  return swizzled_method_name.to_sym
+
+	end
+
+end

data/lib/accessor_utilities/swizzle.rb

@@ -0,0 +1,44 @@
+
+module ::AccessorUtilities::Swizzle
+
+	####################
+	#  swizzle_method  #
+	####################
+
+	def swizzle_method( method_name, swizzled_method_prefix = nil, append_equals_to_method_name = false, & method_definition )
+		
+		swizzling_method_name = ( append_equals_to_method_name ? method_name.write_accessor_name : method_name )
+		
+		swizzled_method_prefix = :swizzle__ unless swizzled_method_prefix
+
+		# alias existing method
+		swizzled_method_name = method_name.swizzle_name( swizzled_method_prefix, append_equals_to_method_name )
+		alias_method( swizzled_method_name, swizzling_method_name )
+		
+		# declare new method in place of old
+		define_method( ( append_equals_to_method_name ? method_name.write_accessor_name : method_name ), & method_definition )
+		
+		return swizzled_method_name
+		
+	end
+
+	######################
+	#  unswizzle_method  #
+	######################
+
+	def unswizzle_method( method_name, swizzled_method_prefix = nil, append_equals_to_method_name = false )
+		
+		swizzling_method_name = ( append_equals_to_method_name ? method_name.write_accessor_name : method_name )
+		
+		# if we have an aliased method, alias it back
+		swizzle_name = method_name.swizzle_name( swizzled_method_prefix, append_equals_to_method_name )
+		alias_method( swizzling_method_name, swizzle_name ) if method_defined?( swizzle_name )
+
+		# remove swizzled method
+		unswizzled_method = remove_method( swizzle_name )
+		
+		return unswizzled_method
+		
+	end
+	
+end

data/lib/accessor_utilities/symbol_instance.rb

@@ -0,0 +1,44 @@
+
+module ::AccessorUtilities::SymbolInstance
+
+	#######################
+	#  is_variable_name?  #
+	#######################
+
+	def is_variable_name?
+    return to_s.is_variable_name?
+	end
+
+	###################
+	#  variable_name  #
+	###################
+
+	def variable_name
+	  return to_s.variable_name
+	end
+	
+	###################
+	#  accessor_name  #
+	###################
+
+	def accessor_name
+	  return to_s.accessor_name
+	end
+
+	#########################
+	#  write_accessor_name  #
+	#########################
+
+	def write_accessor_name
+	  return to_s.write_accessor_name
+	end
+
+	##################
+	#  swizzle_name  #
+	##################
+
+	def swizzle_name( swizzled_method_prefix = 'swizzled__', append_equals_to_method_name = false )
+		return to_s.swizzle_name( swizzled_method_prefix, append_equals_to_method_name )
+	end
+	
+end

data/lib/namespaces.rb

@@ -0,0 +1,3 @@
+
+module ::AccessorUtilities
+end

data/lib/requires.rb

@@ -0,0 +1,6 @@
+
+require_relative 'accessor_utilities/object_instance.rb'
+require_relative 'accessor_utilities/accessor_math.rb'
+require_relative 'accessor_utilities/swizzle.rb'
+require_relative 'accessor_utilities/string_instance.rb'
+require_relative 'accessor_utilities/symbol_instance.rb'

data/spec/accessor_utilities/accessor_math_spec.rb

@@ -0,0 +1,64 @@
+
+require_relative '../../lib/accessor_utilities.rb'
+
+describe AccessorUtilities::AccessorMath do
+
+  ##############################
+  #  status_plus_other_status  #
+  ##############################
+
+  it 'can add one status to another' do
+    
+    class AccessorUtilities::AccessorMath::Mock
+      
+      extend AccessorUtilities::AccessorMath
+      
+      status_plus_other_status( nil, :accessor ).should == :accessor
+      status_plus_other_status( nil, :reader ).should == :reader
+      status_plus_other_status( nil, :writer ).should == :writer
+
+      status_plus_other_status( :accessor, :accessor ).should == :accessor
+      status_plus_other_status( :accessor, :reader ).should == :accessor
+      status_plus_other_status( :accessor, :writer ).should == :accessor
+
+      status_plus_other_status( :reader, :accessor ).should == :accessor
+      status_plus_other_status( :reader, :reader ).should == :reader
+      status_plus_other_status( :reader, :writer ).should == :accessor
+
+      status_plus_other_status( :writer, :accessor ).should == :accessor
+      status_plus_other_status( :writer, :reader ).should == :accessor
+      status_plus_other_status( :writer, :writer ).should == :writer
+
+    end
+    
+  end
+
+  ###############################
+  #  status_minus_other_status  #
+  ###############################
+  
+  it 'can subtract one status from another' do
+
+    class AccessorUtilities::AccessorMath::Mock
+
+      status_minus_other_status( nil, :accessor ).should == nil
+      status_minus_other_status( nil, :reader ).should == nil
+      status_minus_other_status( nil, :writer ).should == nil
+
+      status_minus_other_status( :accessor, :accessor ).should == nil
+      status_minus_other_status( :accessor, :reader ).should == :writer
+      status_minus_other_status( :accessor, :writer ).should == :reader
+
+      status_minus_other_status( :reader, :accessor ).should == nil
+      status_minus_other_status( :reader, :reader ).should == nil
+      status_minus_other_status( :reader, :writer ).should == :reader
+
+      status_minus_other_status( :writer, :accessor ).should == nil
+      status_minus_other_status( :writer, :reader ).should == :writer
+      status_minus_other_status( :writer, :writer ).should == nil
+    
+    end
+    
+  end
+  
+end

data/spec/accessor_utilities/object_instance_spec.rb

@@ -0,0 +1,19 @@
+
+require_relative '../../lib/accessor_utilities.rb'
+
+describe AccessorUtilities::ObjectInstance do
+  
+  #####################################
+	#  instance_variables_as_accessors  #
+	#####################################
+	
+	it 'can return a list of instance variables translated into corresponding accessor names' do
+	  object_instance = Object.new
+	  object_instance.instance_eval do
+	    @some_variable = :value
+	    @other_variable = :value
+    end
+    object_instance.instance_variables_as_accessors.should == [ :some_variable, :other_variable ]
+  end
+  
+end

data/spec/accessor_utilities/string_instance_spec.rb

@@ -0,0 +1,51 @@
+
+require_relative '../../lib/accessor_utilities.rb'
+
+describe AccessorUtilities::StringInstance do
+	
+	#######################
+	#  is_variable_name?  #
+	#######################
+
+	it 'can report if a string is a variable name' do
+		'@variable'.is_variable_name?.should == true
+		'not_variable'.is_variable_name?.should == false
+	end
+
+	###################
+	#  variable_name  #
+	###################
+
+	it 'can return variable name for variable or accessor name' do
+		'@variable'.variable_name.should == :@variable
+		'not_variable'.variable_name.should == :@not_variable
+	end
+	
+	###################
+	#  accessor_name  #
+	###################
+
+	it 'can return accessor name for variable or accessor name' do
+		'@variable'.accessor_name.should == :variable
+		'not_variable'.accessor_name.should == :not_variable
+	end
+	
+	#########################
+	#  write_accessor_name  #
+	#########################
+
+	it 'can return write accessor name for accessor name' do
+		'accessor_name'.write_accessor_name.should == :accessor_name=
+	end
+
+	##################
+	#  swizzle_name  #
+	##################
+
+  it 'can return a swizzle name given a prefix for an accessor name' do
+    'accessor_name'.swizzle_name.should == :swizzled__accessor_name
+    'accessor_name'.swizzle_name( :swizzle_prefix__, false ).should == :swizzle_prefix__accessor_name
+    'accessor_name'.swizzle_name( :swizzle_prefix__, true ).should == :swizzle_prefix__accessor_name=
+  end
+  
+end

data/spec/accessor_utilities/swizzle_spec.rb

@@ -0,0 +1,50 @@
+
+require_relative '../../lib/accessor_utilities.rb'
+
+describe AccessorUtilities::Swizzle do
+
+  ######################
+  #  swizzle_method    #
+  #  unswizzle_method  #
+  ######################
+  
+  it 'can swizzle and unswizzle a method with a new method' do
+    class AccessorUtilities::Swizzle::Mock
+      def method_to_swizzle
+        return @return_value ||= :first_value
+      end
+      def method_to_swizzle=( value )
+        @return_value = value
+      end
+    end
+    object_instance = AccessorUtilities::Swizzle::Mock.new
+    object_instance.method_to_swizzle.should == :first_value
+    object_instance.method_to_swizzle = :value
+    object_instance.method_to_swizzle.should == :value
+    class AccessorUtilities::Swizzle::Mock
+      extend AccessorUtilities::Swizzle
+      swizzle_method( :method_to_swizzle, :swizzle_prefix__, false ) do
+        :second_value
+      end
+      swizzle_method( :method_to_swizzle, :swizzle_prefix__, true ) do |value|
+        :second_value=
+      end
+    end
+    object_instance.method_to_swizzle.should == :second_value
+    object_instance.method_to_swizzle = :value
+    object_instance.method_to_swizzle.should == :second_value
+    object_instance.swizzle_prefix__method_to_swizzle.should == :value
+    object_instance.swizzle_prefix__method_to_swizzle.should == :value
+    object_instance.method_to_swizzle.should == :second_value
+    class AccessorUtilities::Swizzle::Mock
+      unswizzle_method( :method_to_swizzle, :swizzle_prefix__, false )
+      unswizzle_method( :method_to_swizzle, :swizzle_prefix__, true )
+    end
+    object_instance.method_to_swizzle.should == :value
+    object_instance.method_to_swizzle = :first_value
+    object_instance.method_to_swizzle.should == :first_value
+    AccessorUtilities::Swizzle::Mock.method_defined?( :swizzle_prefix__method_to_swizzle ).should == false
+    AccessorUtilities::Swizzle::Mock.method_defined?( :swizzle_prefix__method_to_swizzle= ).should == false
+  end
+  
+end

data/spec/accessor_utilities/symbol_instance_spec.rb

@@ -0,0 +1,51 @@
+
+require_relative '../../lib/accessor_utilities.rb'
+
+describe AccessorUtilities::SymbolInstance do
+
+	#######################
+	#  is_variable_name?  #
+	#######################
+
+	it 'can report if a string is a variable name' do
+		:@variable.is_variable_name?.should == true
+		:not_variable.is_variable_name?.should == false
+	end
+
+	###################
+	#  variable_name  #
+	###################
+
+	it 'can return variable name for variable or accessor name' do
+		:@variable.variable_name.should == :@variable
+		:not_variable.variable_name.should == :@not_variable
+	end
+	
+	###################
+	#  accessor_name  #
+	###################
+
+	it 'can return accessor name for variable or accessor name' do
+		:@variable.accessor_name.should == :variable
+		:not_variable.accessor_name.should == :not_variable		
+	end
+	
+	#########################
+	#  write_accessor_name  #
+	#########################
+
+	it 'can return write accessor name for accessor name' do
+		:accessor_name.write_accessor_name.should == :accessor_name=
+	end
+
+	##################
+	#  swizzle_name  #
+	##################
+
+  it 'can return a swizzle name given a prefix for an accessor name' do
+    :accessor_name.swizzle_name.should == :swizzled__accessor_name
+    :accessor_name.swizzle_name( :swizzle_prefix__, false ).should == :swizzle_prefix__accessor_name
+    :accessor_name.swizzle_name( :swizzle_prefix__, true ).should == :swizzle_prefix__accessor_name=
+  end
+
+end

data/spec/accessor_utilities_spec.rb

@@ -0,0 +1,9 @@
+
+require_relative '../lib/accessor_utilities.rb'
+
+describe AccessorUtilities do
+
+  # nothing unique here
+  # implicitly includes or extends supporting modules in correspondence to request
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: accessor_utilities
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Asher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-06 00:00:00.000000000 Z
+dependencies: []
+description: Extends String and Symbol instances with variable/accessor methods, provides
+  swizzling helpers, provides accessor-related math for transforming :accessor, :reader,
+  :writer.
+email: asher@ridiculouspower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/accessor_utilities/accessor_math.rb
+- lib/accessor_utilities/object_instance.rb
+- lib/accessor_utilities/string_instance.rb
+- lib/accessor_utilities/swizzle.rb
+- lib/accessor_utilities/symbol_instance.rb
+- lib/accessor_utilities.rb
+- lib/namespaces.rb
+- lib/requires.rb
+- spec/accessor_utilities/accessor_math_spec.rb
+- spec/accessor_utilities/object_instance_spec.rb
+- spec/accessor_utilities/string_instance_spec.rb
+- spec/accessor_utilities/swizzle_spec.rb
+- spec/accessor_utilities/symbol_instance_spec.rb
+- spec/accessor_utilities_spec.rb
+- README.md
+homepage: http://rubygems.org/gems/accessor_utilities
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: accessor_utilities
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Utility methods for accessor-related meta-programming.
+test_files: []
+has_rdoc: