adamantium 0.0.1

data/spec/unit/adamantium/freeze_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe Adamantium, '#freeze' do
+  subject { object.freeze }
+
+  let(:described_class) { Class.new(AdamantiumSpecs::Object) }
+
+  before do
+    described_class.memoize(:test)
+  end
+
+  context 'with an unfrozen object' do
+    let(:object) { described_class.allocate }
+
+    it_should_behave_like 'a command method'
+
+    it 'freezes the object' do
+      expect { subject }.to change(object, :frozen?).
+        from(false).
+        to(true)
+    end
+
+    it 'sets a memoization instance variable' do
+      object.should_not be_instance_variable_defined(:@__memory)
+      subject
+      object.instance_variable_get(:@__memory).should be_instance_of(Adamantium::Memory)
+    end
+  end
+
+  context 'with a frozen object' do
+    let(:object) { described_class.new }
+
+    it_should_behave_like 'a command method'
+
+    it 'does not change the frozen state of the object' do
+      expect { subject }.to_not change(object, :frozen?)
+    end
+
+    it 'does not change the memoization instance variable' do
+      expect { subject }.to_not change { object.instance_variable_get(:@__memory) }
+    end
+
+    it 'does not set an instance variable for memoization' do
+      object.instance_variable_get(:@__memory).should be_instance_of(Adamantium::Memory)
+      subject
+    end
+  end
+end

data/spec/unit/adamantium/memoize_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe Adamantium, '#memoize' do
+  subject { object.memoize(method, value) }
+
+  let(:described_class) { Class.new(AdamantiumSpecs::Object) }
+  let(:object)          { described_class.new               }
+  let(:method)          { :test                             }
+
+  before do
+    described_class.memoize(method)
+  end
+
+  context 'when the value is frozen' do
+    let(:value) { String.new.freeze }
+
+    it 'sets the memoized value for the method to the value' do
+      subject
+      object.send(method).should equal(value)
+    end
+
+    it 'creates a method that returns a frozen value' do
+      subject
+      object.send(method).should be_frozen
+    end
+  end
+
+  context 'when the value is not frozen' do
+    let(:value) { String.new }
+
+    it 'sets the memoized value for the method to the value' do
+      subject
+      object.send(method).should eql(value)
+    end
+
+    it 'creates a method that returns a frozen value' do
+      subject
+      object.send(method).should be_frozen
+    end
+  end
+
+  context 'when the method is already memoized' do
+    let(:value)    { stub }
+    let(:original) { nil  }
+
+    before do
+      object.memoize(method, original)
+    end
+
+    it 'does not change the value' do
+      expect { subject }.to_not change { object.send(method) }
+    end
+  end
+end

data/spec/unit/adamantium/memoized_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path('../fixtures/classes', __FILE__)
+
+describe Adamantium, '#memoized' do
+  subject { object.memoized(method) }
+
+  let(:described_class) { Class.new(AdamantiumSpecs::Object) }
+  let(:method)          { :test                             }
+  let(:value)           { String.new.freeze                 }
+  let(:object)          { described_class.new               }
+
+  before do
+    described_class.memoize(method)
+  end
+
+  context 'when a method is memoized' do
+    before do
+      object.memoize(method, value)
+    end
+
+    it { should equal(value) }
+  end
+
+  context 'when a method is not memoized' do
+    it { should be_nil }
+  end
+end

data/spec/unit/adamantium/module_methods/included_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+describe Adamantium::ModuleMethods, '#included' do
+  subject { object.included(object) }
+
+  let(:object) { AdamantiumSpecs::Object }
+
+  before do
+    Adamantium.should_receive(:included).with(object).and_return(Adamantium)
+  end
+
+  it_should_behave_like 'a command method'
+end

data/spec/unit/adamantium/module_methods/memoize_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require File.expand_path('../../fixtures/classes', __FILE__)
+
+shared_examples_for 'memoizes method' do
+  it 'memoizes the instance method' do
+    subject
+    instance = object.new
+    instance.send(method).should equal(instance.send(method))
+  end
+
+  it 'creates a method that returns a frozen value' do
+    subject
+    object.new.send(method).should be_frozen
+  end
+
+  specification = proc do
+    subject
+    file, line = object.new.send(method).first.split(':')[0, 2]
+    File.expand_path(file).should eql(File.expand_path('../../../../../lib/adamantium.rb', __FILE__))
+    line.to_i.should eql(211)
+  end
+
+  it 'sets the file and line number properly' do
+    if RUBY_PLATFORM.include?('java')
+      pending('Kernel#caller returns the incorrect line number in JRuby', &specification)
+    else
+      instance_eval(&specification)
+    end
+  end
+
+  context 'when the initializer calls the memoized method' do
+    before do
+      method = self.method
+      object.send(:define_method, :initialize) { send(method) }
+    end
+
+    it 'allows the memoized method to be called within the initializer' do
+      subject
+      expect { object.new }.to_not raise_error(NoMethodError)
+    end
+
+    it 'memoizes the methdod inside the initializer' do
+      subject
+      object.new.memoized(method).should_not be_nil
+    end
+  end
+end
+
+describe Adamantium::ModuleMethods, '#memoize' do
+  subject { object.memoize(method) }
+
+  let(:object) { Class.new(AdamantiumSpecs::Object) }
+
+  context 'public method' do
+    let(:method) { :public_method }
+
+    it_should_behave_like 'a command method'
+    it_should_behave_like 'memoizes method'
+
+    it 'is still a public method' do
+      should be_public_method_defined(method)
+    end
+  end
+
+  context 'protected method' do
+    let(:method) { :protected_method }
+
+    it_should_behave_like 'a command method'
+    it_should_behave_like 'memoizes method'
+
+    it 'is still a protected method' do
+      should be_protected_method_defined(method)
+    end
+  end
+
+  context 'private method' do
+    let(:method) { :private_method }
+
+    it_should_behave_like 'a command method'
+    it_should_behave_like 'memoizes method'
+
+    it 'is still a private method' do
+      should be_private_method_defined(method)
+    end
+  end
+end

data/tasks/metrics/ci.rake

@@ -0,0 +1,7 @@
+desc 'Run metrics with Heckle'
+task :ci => %w[ ci:metrics heckle ]
+
+namespace :ci do
+  desc 'Run metrics'
+  task :metrics => %w[ verify_measurements flog flay reek roodi metrics:all ]
+end

data/tasks/metrics/flay.rake

@@ -0,0 +1,47 @@
+begin
+  if RUBY_VERSION == '1.8.7'
+    require 'flay'
+    require 'yaml'
+
+    config      = YAML.load_file(File.expand_path('../../../config/flay.yml', __FILE__)).freeze
+    threshold   = config.fetch('threshold').to_i
+    total_score = config.fetch('total_score').to_f
+    files       = Flay.expand_dirs_to_files(config.fetch('path', 'lib'))
+
+    # original code by Marty Andrews:
+    # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+    desc 'Analyze for code duplication'
+    task :flay do
+      # run flay once without a threshold to ensure the max mass matches the threshold
+      flay = Flay.new(:fuzzy => false, :verbose => false, :mass => 0)
+      flay.process(*files)
+
+      max = flay.masses.map { |hash, mass| mass.to_f / flay.hashes[hash].size }.max
+      unless max >= threshold
+        raise "Adjust flay threshold down to #{max}"
+      end
+
+      total = flay.masses.reduce(0.0) { |total, (hash, mass)| total + (mass.to_f / flay.hashes[hash].size) }
+      unless total == total_score
+        raise "Flay total is now #{total}, but expected #{total_score}"
+      end
+
+      # run flay a second time with the threshold set
+      flay = Flay.new(:fuzzy => false, :verbose => false, :mass => threshold.succ)
+      flay.process(*files)
+
+      if flay.masses.any?
+        flay.report
+        raise "#{flay.masses.size} chunks of code have a duplicate mass > #{threshold}"
+      end
+    end
+  else
+    task :flay do
+      $stderr.puts 'Flay has inconsistend results accros ruby implementations. It is only enabled on 1.8.7, fix and remove guard'
+    end
+  end
+rescue LoadError
+  task :flay do
+    abort 'Flay is not available. In order to run flay, you must: gem install flay'
+  end
+end

data/tasks/metrics/flog.rake

@@ -0,0 +1,43 @@
+begin
+  require 'flog'
+  require 'yaml'
+
+  class Float
+    def round_to(n)
+      (self * 10**n).round.to_f * 10**-n
+    end
+  end
+
+  config    = YAML.load_file(File.expand_path('../../../config/flog.yml', __FILE__)).freeze
+  threshold = config.fetch('threshold').to_f.round_to(1)
+
+  # original code by Marty Andrews:
+  # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+  desc 'Analyze for code complexity'
+  task :flog do
+    flog = Flog.new
+    flog.flog Array(config.fetch('path', 'lib'))
+
+    totals = flog.totals.select  { |name, score| name[-5, 5] != '#none' }.
+                         map     { |name, score| [ name, score.round_to(1) ] }.
+                         sort_by { |name, score| score }
+
+    max = totals.last[1]
+    unless max >= threshold
+      raise "Adjust flog score down to #{max}"
+    end
+
+    bad_methods = totals.select { |name, score| score > threshold }
+    if bad_methods.any?
+      bad_methods.reverse_each do |name, score|
+        puts '%8.1f: %s' % [ score, name ]
+      end
+
+      raise "#{bad_methods.size} methods have a flog complexity > #{threshold}"
+    end
+  end
+rescue LoadError
+  task :flog do
+    abort 'Flog is not available. In order to run flog, you must: gem install flog'
+  end
+end

data/tasks/metrics/heckle.rake

@@ -0,0 +1,208 @@
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+
+# original code by Ashley Moran:
+# http://aviewfromafar.net/2007/11/1/rake-task-for-heckling-your-specs
+
+begin
+  require 'pathname'
+  require 'backports'
+  require 'active_support/inflector'
+  require 'heckle'
+  require 'mspec'
+  require 'mspec/utils/name_map'
+
+  SKIP_METHODS = %w[ blank_slate_method_added ].freeze
+
+  class NameMap
+    def file_name(method, constant)
+      map  = MAP[method]
+      name = if map
+        map[constant] || map[:default]
+      else
+        method.
+          gsub('?','_ques').
+          gsub('!','_bang').
+          gsub('=','_assign')
+      end
+      "#{name}_spec.rb"
+    end
+  end
+
+  desc 'Heckle each module and class'
+  task :heckle => :rcov do
+    unless Ruby2Ruby::VERSION == '1.2.2'
+      raise "ruby2ruby version #{Ruby2Ruby::VERSION} may not work properly, 1.2.2 *only* is recommended for use with heckle"
+    end
+
+    require 'adamantium'
+
+    root_module_regexp = Regexp.union('Adamantium')
+
+    spec_dir = Pathname('spec/unit')
+
+    NameMap::MAP.each do |op, method|
+      next if method.kind_of?(Hash)
+      NameMap::MAP[op] = { :default => method }
+    end
+
+    aliases = Hash.new { |h,mod| h[mod] = Hash.new { |h,method| h[method] = method } }
+    map     = NameMap.new
+
+    heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+    unhandled_mutations = 0
+
+    ObjectSpace.each_object(Module) do |mod|
+      next unless mod.name =~ /\A#{root_module_regexp}(?::|\z)/
+
+      spec_prefix = spec_dir.join(mod.name.underscore)
+
+      specs = []
+
+      # get the public class methods
+      metaclass  = class << mod; self end
+      ancestors  = metaclass.ancestors
+
+      spec_class_methods = mod.singleton_methods(false)
+
+      spec_class_methods.reject! do |method|
+        %w[ yaml_new yaml_tag_subclasses? included nesting constants ].include?(method.to_s)
+      end
+
+      if mod.ancestors.include?(Singleton)
+        spec_class_methods.reject! { |method| method.to_s == 'instance' }
+      end
+
+      # get the protected and private class methods
+      other_class_methods = metaclass.protected_instance_methods(false) |
+                            metaclass.private_instance_methods(false)
+
+      ancestors.each do |ancestor|
+        other_class_methods -= ancestor.protected_instance_methods(false) |
+                               ancestor.private_instance_methods(false)
+      end
+
+      other_class_methods.reject! do |method|
+        method.to_s == 'allocate' || SKIP_METHODS.include?(method.to_s)
+      end
+
+      other_class_methods.reject! do |method|
+        next unless spec_class_methods.any? { |specced| specced.to_s == $1 }
+
+        spec_class_methods << method
+      end
+
+      # get the instances methods
+      spec_methods = mod.public_instance_methods(false)
+
+      other_methods = mod.protected_instance_methods(false) |
+                      mod.private_instance_methods(false)
+
+      other_methods.reject! do |method|
+        next unless spec_methods.any? { |specced| specced.to_s == $1 }
+
+        spec_methods << method
+      end
+
+      # map the class methods to spec files
+      spec_class_methods.each do |method|
+        method = aliases[mod.name][method]
+        next if SKIP_METHODS.include?(method.to_s)
+
+        spec_file = spec_prefix.join('class_methods').join(map.file_name(method, mod.name))
+
+        unless spec_file.file?
+          raise "No spec file #{spec_file} for #{mod}.#{method}"
+          next
+        end
+
+        specs << [ ".#{method}", [ spec_file ] ]
+      end
+
+      # map the instance methods to spec files
+      spec_methods.each do |method|
+        method = aliases[mod.name][method]
+        next if SKIP_METHODS.include?(method.to_s)
+
+        spec_file = spec_prefix.join(map.file_name(method, mod.name))
+
+        unless spec_file.file?
+          raise "No spec file #{spec_file} for #{mod}##{method}"
+          next
+        end
+
+        specs << [ "##{method}", [ spec_file ] ]
+      end
+
+      # non-public methods are considered covered if they can be mutated
+      # and any spec fails for the current or descendant modules
+      other_methods.each do |method|
+        descedant_specs = []
+
+        ObjectSpace.each_object(Module) do |descedant|
+          next unless descedant.name =~ /\A#{root_module_regexp}(?::|\z)/ && mod >= descedant
+          descedant_spec_prefix = spec_dir.join(descedant.name.underscore)
+          descedant_specs << descedant_spec_prefix
+
+          if method.to_s == 'initialize'
+            descedant_specs.concat(Pathname.glob(descedant_spec_prefix.join('class_methods/new_spec.rb')))
+          end
+        end
+
+        specs << [ "##{method}", descedant_specs ]
+      end
+
+      other_class_methods.each do |method|
+        descedant_specs = []
+
+        ObjectSpace.each_object(Module) do |descedant|
+          next unless descedant.name =~ /\A#{root_module_regexp}(?::|\z)/ && mod >= descedant
+          descedant_specs << spec_dir.join(descedant.name.underscore).join('class_methods')
+        end
+
+        specs << [ ".#{method}", descedant_specs ]
+      end
+
+      specs.sort.each do |(method, spec_files)|
+        puts "Heckling #{mod}#{method}"
+        IO.popen("spec #{spec_files.join(' ')} --heckle '#{mod}#{method}'") do |pipe|
+          while line = pipe.gets
+            case line = line.chomp
+              when "The following mutations didn't cause test failures:"
+                heckle_caught_modules[mod.name] << method
+              when '+++ mutation'
+                unhandled_mutations += 1
+            end
+          end
+        end
+      end
+    end
+
+    if unhandled_mutations > 0
+      error_message_lines = [ "*************\n" ]
+
+      error_message_lines << "Heckle found #{unhandled_mutations} " \
+        "mutation#{"s" unless unhandled_mutations == 1} " \
+        "that didn't cause spec violations\n"
+
+      heckle_caught_modules.each do |mod, methods|
+        error_message_lines << "#{mod} contains the following " \
+          'poorly-specified methods:'
+        methods.each do |method|
+          error_message_lines << " - #{method}"
+        end
+        error_message_lines << ''
+      end
+
+      error_message_lines << 'Get your act together and come back ' \
+        'when your specs are doing their job!'
+
+      raise error_message_lines.join("\n")
+    else
+      puts 'Well done! Your code withstood a heckling.'
+    end
+  end
+rescue LoadError
+  task :heckle => :spec do
+    $stderr.puts 'Heckle or mspec is not available. In order to run heckle, you must: gem install heckle mspec'
+  end
+end