block_changes 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", ">= 1.0"
+  gem "jeweler", ">= 1.6.4"
+  gem "simplecov"
+  gem "rspec"
+end

data/README.md

@@ -0,0 +1,29 @@
+Block Changes
+=============
+
+Detecting changes in a Ruby block
+---------------------------------
+The following example illustrates how to see if changes are detected in a Ruby block for the expected variables. Variables a, b, c are concerned in this example. If these variables are changed `changes_detected?` will return true. If these variables are not changes in the block `changes_detected?` will return false. This will be helpful to maintain idempotency. The following example is very simple. We'll know what variables we concern about when we write the code so passing those variables to the code will not be hard. Also we might not want to detect changes of local temporary variables defined inside the block.
+
+```ruby
+require 'block_changes'
+
+include BlockChanges
+
+a = 1
+b = 2
+c = 3
+
+# Note that the variable names are in quotes and it is required.
+detect_changes('a', 'b', 'c') do
+  a = 2
+  b = 3
+  c = 4
+end
+
+# Check if changes are detected in the block
+puts "Changes Detected" if changes_detected?
+
+# Check the number variables changed in the block
+puts "No of changes: #{get_changes}"
+```

data/Rakefile

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/block_changes', __FILE__)
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name         = 'block_changes'
+  gemspec.version      = BlockChanges::VERSION
+  gemspec.platform     = Gem::Platform::RUBY
+  gemspec.date         = Time.now.utc.strftime("%Y-%m-%d")
+  gemspec.require_path = 'lib'
+  gemspec.files        = `git ls-files`.split("\n")
+  gemspec.extra_rdoc_files = ['LICENSE', 'README.md']
+  gemspec.authors      = [ 'Kannan Manickam' ]
+  gemspec.email        = [ 'arangamani.kannan@gmail.com' ]
+  gemspec.homepage     = 'https://github.com/arangamani/block_changes'
+  gemspec.summary      = 'Ruby Module for Detecting Variable Changes in a Block'
+  gemspec.description  = %{
+This is a simple Ruby module for detecting variable changes inside a block for improving code
+with increased idempotency.}
+  gemspec.test_files = `git ls-files -- {spec}/*`.split("\n")
+  gemspec.rubygems_version = '1.8.17'
+end

data/examples/sample.rb

@@ -0,0 +1,43 @@
+#
+# Copyright (c) 2012 Kannan Manickam <arangamani.kannan@gmail.com>
+#
+# 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.
+#
+
+require File.expand_path('../../lib/block_changes', __FILE__)
+
+include BlockChanges
+
+puts "[BEFORE] Changes detected: #{changes_detected?}"
+
+# Some variables are defined
+some_var = 5
+some_hash = { :var => 5 }
+some_array = [4, 5, 'str']
+detect_changes('some_var', 'some_hash', 'some_array') do
+  some_var = 6
+  some_hash[:var] = 6
+  some_array[0] += 1
+end
+
+puts "some_var = #{some_var}"
+puts "some_hash = #{some_hash}"
+puts "some_array = #{some_array}"
+puts "[AFTER] Changes detected: #{changes_detected?}"
+puts "[AFTER] No of changes: #{get_changes}"

data/lib/block_changes.rb

@@ -0,0 +1,81 @@
+#
+# Copyright (c) 2013 Kannan Manickam <arangamani.kannan@gmail.com>
+#
+# 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.
+#
+
+module BlockChanges
+
+  # Version information
+  MAJOR   = 0
+  MINOR   = 0
+  TINY    = 1
+  PRE     = nil
+  VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+
+  @changes_detected = nil
+  @no_of_block_changes = 0
+
+  def changes_detected?
+    @changes_detected
+  end
+
+  def reset_changes
+    @changes_detected = nil
+    @no_of_block_changes = 0
+  end
+
+  def get_changes
+    @no_of_block_changes
+  end
+
+  def detect_changes(*vars, &block)
+    # Reset changes done in the previous block if any
+    reset_changes
+
+    # Collect all variables and put it in an array
+    old_vars = []
+    vars.each do |var|
+      var_eval = eval(var, block.binding)
+      if var_eval.is_a?(Hash) || var_eval.is_a?(Array)
+        var_eval = var_eval.clone
+      end
+      old_vars << var_eval
+    end
+
+    # Execute the block
+    block.call
+
+    # Obtain the variables after the block execution
+    new_vars = []
+    vars.each do |var|
+      var_eval = eval(var, block.binding)
+      if var_eval.is_a?(Hash) || var_eval.is_a?(Array)
+        var_eval = var_eval.clone
+      end
+      new_vars << var_eval
+    end
+
+    # Check if there were any changes detected during block execution
+    vars.each_with_index do |_, index|
+      @no_of_block_changes += 1 if old_vars[index] != new_vars[index]
+    end
+    @changes_detected = @no_of_block_changes > 0
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: block_changes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kannan Manickam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '
+
+  This is a simple Ruby module for detecting variable changes inside a block for improving
+  code
+
+  with increased idempotency.'
+email:
+- arangamani.kannan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/sample.rb
+- lib/block_changes.rb
+homepage: https://github.com/arangamani/block_changes
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Module for Detecting Variable Changes in a Block
+test_files: []