mtrack 0.0.1

data/spec/lib/mtrack/state/group_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe MTrack::State::Group do
+  context "newly instantiated" do
+    it "is initialized empty" do
+      expect(subject.tracked).to be_empty
+    end
+  end
+
+  context "already in use" do
+    let(:sample_tracked) { [:trk_1, :trk_2, :trk_3] }
+
+    subject do
+      described_class.new.tap do |o|
+        o.merge_tracked sample_tracked
+      end
+    end
+
+    it "is not empty" do
+      expect(subject.tracked).to match_array(sample_tracked)
+    end
+
+    it "does not modify internal state through attribute readers" do
+      expect(subject.tracked.add(:v)).to match_array(sample_tracked + [:v])
+      expect(subject.tracked).to match_array(sample_tracked)
+    end
+
+    it "deletes tracked values" do
+      expect(subject.delete_tracked(:trk_2)).to be(:trk_2)
+      expect(subject.tracked).to match_array(sample_tracked - [:trk_2])
+    end
+
+    it "merges tracked values" do
+      expect(subject.merge_tracked([:x, :y, :z])).to match_array([:x, :y, :z])
+      expect(subject.tracked).to match_array(sample_tracked + [:x, :y, :z])
+    end
+  end
+end

data/spec/lib/mtrack/state_spec.rb

@@ -0,0 +1,135 @@
+require "spec_helper"
+
+describe MTrack::State do
+  let(:sample_group) do
+    { :con_1 => { :tracked => [:trk_1, :trk_2] },
+      :con_2 => { :tracked => [:trk_2, :trk_3] }
+    }
+  end
+  let(:sample_group_2) do
+    { :con_2 => { :tracked => [:trk_3, :trk_4] },
+      :con_3 => { :tracked => [:trk_4, :trk_5] }
+    }
+  end
+
+  let(:sample_undefined) { [:und_1, :und_2, :und_3] }
+
+  let(:sample_state) do
+    described_class.new.tap do |o|
+      sample_group.keys.each do |key|
+        o[key].merge_tracked sample_group[key][:tracked]
+      end
+      sample_undefined.each {|v| o.add_undefined v }
+    end
+  end
+  let(:sample_state_2) do
+    described_class.new.tap do |o|
+      sample_group_2.keys.each do |key|
+        o[key].merge_tracked sample_group_2[key][:tracked]
+      end
+    end
+  end
+
+  it "adds a new group when using the `[]` operator" do
+    expect(new_group = subject[:new_group]).to be_a(MTrack::State::Group)
+    expect(subject[:new_group]).to be(new_group)
+  end
+
+  it "adds super states" do
+    expect(subject.add_super_state(sample_state)).to be(sample_state)
+    expect(subject.add_super_state(sample_state_2)).to be(sample_state_2)
+  end
+
+  context "newly instantiated" do
+    context "without super state" do
+      subject { described_class.new }
+
+      it "does not have tracked methods" do
+        expect(subject.tracked).to be_empty
+      end
+    end
+
+    context "with super state" do
+      subject { described_class.new sample_state }
+
+      it "has super state's tracked methods" do
+        expect(sample_state.tracked(:con_1)).to match_array(sample_group[:con_1][:tracked])
+        expect(sample_state.tracked(:con_2)).to match_array(sample_group[:con_2][:tracked])
+        expect(subject.tracked(:con_1)).to match_array(sample_state.tracked(:con_1))
+        expect(subject.tracked(:con_2)).to match_array(sample_state.tracked(:con_2))
+      end
+    end
+
+    context "with multiple super states" do
+      subject { described_class.new(sample_state).tap {|s| s.add_super_state sample_state_2 } }
+
+      it "merges tracked methods from all super states" do
+        expect(subject.tracked(:con_1)).to match_array(sample_group[:con_1][:tracked])
+        expect(subject.tracked(:con_2)).to match_array(sample_group[:con_2][:tracked] | sample_group_2[:con_2][:tracked])
+        expect(subject.tracked(:con_3)).to match_array(sample_group_2[:con_3][:tracked])
+      end
+
+      it "returns tracked methods that are not undefined" do
+        subject.add_undefined :trk_3
+        expect(subject.tracked(:con_2)).to match_array((sample_group[:con_2][:tracked] | sample_group_2[:con_2][:tracked]) - [:trk_3])
+
+        subject.delete_undefined :trk_3
+        expect(subject.tracked(:con_2)).to match_array((sample_group[:con_2][:tracked] | sample_group_2[:con_2][:tracked]))
+      end
+    end
+  end
+
+  context "already in use" do
+    subject { sample_state }
+
+    it "is not empty" do
+      expect(subject[:con_1].tracked).to match_array(sample_group[:con_1][:tracked])
+      expect(subject[:con_2].tracked).to match_array(sample_group[:con_2][:tracked])
+    end
+
+    it "adds undefined methods" do
+      expect(subject.add_undefined(:v)).to eq(:v)
+    end
+
+    it "deletes tracked methods" do
+      expect(subject.delete_tracked(:trk_2)).to eq(:trk_2)
+      expect(subject[:con_1].tracked).to match_array(sample_group[:con_1][:tracked] - [:trk_2])
+      expect(subject[:con_2].tracked).to match_array(sample_group[:con_2][:tracked] - [:trk_2])
+    end
+
+    it "deletes undefined methods" do
+      expect(subject.delete_undefined(:und_2)).to eq(:und_2)
+    end
+
+    it "returns tracked methods that are not undefined" do
+      expect(subject.tracked(:con_1)).to match_array(sample_group[:con_1][:tracked])
+      expect(subject.tracked(:con_2)).to match_array(sample_group[:con_2][:tracked])
+
+      subject.add_undefined :trk_2
+      expect(subject.tracked(:con_1)).to match_array(sample_group[:con_1][:tracked] - [:trk_2])
+      expect(subject.tracked(:con_2)).to match_array(sample_group[:con_2][:tracked] - [:trk_2])
+
+      subject.delete_undefined :trk_2
+      expect(subject.tracked(:con_1)).to match_array(sample_group[:con_1][:tracked])
+      expect(subject.tracked(:con_2)).to match_array(sample_group[:con_2][:tracked])
+    end
+
+    context "with super state" do
+      subject { sample_state.tap {|s| s.add_super_state sample_state_2 } }
+
+      it "merges tracked methods from current and super states" do
+        expect(subject.tracked(:con_1)).to match_array(sample_group[:con_1][:tracked])
+        expect(subject.tracked(:con_2)).to match_array(sample_group[:con_2][:tracked] | sample_group_2[:con_2][:tracked])
+        expect(subject.tracked(:con_3)).to match_array(sample_group_2[:con_3][:tracked])
+      end
+
+      it "returns tracked methods that are not undefined" do
+        subject.add_undefined :trk_3
+        expect(subject.tracked(:con_2)).to match_array((sample_group[:con_2][:tracked] | sample_group_2[:con_2][:tracked]) - [:trk_3])
+
+        subject.delete_undefined :trk_3
+        expect(subject.tracked(:con_2)).to match_array((sample_group[:con_2][:tracked] | sample_group_2[:con_2][:tracked]))
+      end
+    end
+  end
+end

data/spec/lib/mtrack/version_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe MTrack::VERSION do
+  it { should_not be_nil }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+unless ENV["COVERAGE"].nil?
+  require "codeclimate-test-reporter"
+  SimpleCov.start do
+    formatter SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ]
+    add_filter "/spec/"
+  end
+end
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "mtrack"
+
+RSpec.configure do |config|
+  config.color = true
+  config.order = :rand
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/tasks/console.rb

@@ -0,0 +1,13 @@
+desc "Open a console with the #{Bundler::GemHelper.gemspec.name} gem loaded"
+task :console do
+  require Bundler::GemHelper.gemspec.name
+
+  if RUBY_VERSION >= "1.9"
+    require "pry"
+    Pry.start
+  else
+    require "irb"
+    ARGV.clear
+    IRB.start
+  end
+end

data/tasks/coverage.rb

@@ -0,0 +1,9 @@
+desc "Run tests and generate coverage report"
+task :coverage do
+  if RUBY_VERSION >= "1.9"
+    ENV["COVERAGE"] = "true"
+  else
+    warn "Ruby version 1.9+ is needed in order to generate coverage report."
+  end
+  Rake::Task[:spec].invoke
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: mtrack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gabriel de Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: codeclimate-test-reporter
+  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: pry
+  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: rake
+  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: 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: simplecov
+  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: MTrack extends the functionality of modules and classes and enables them
+  to define public methods within groups. These methods can then be queried back even
+  through a hierarchy of inclusion and/or inheritance.
+email:
+- deoliveira.gab@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mtrack.rb
+- lib/mtrack/core.rb
+- lib/mtrack/module_mixin.rb
+- lib/mtrack/state.rb
+- lib/mtrack/state/group.rb
+- lib/mtrack/version.rb
+- mtrack.gemspec
+- spec/lib/mtrack/core_spec.rb
+- spec/lib/mtrack/state/group_spec.rb
+- spec/lib/mtrack/state_spec.rb
+- spec/lib/mtrack/version_spec.rb
+- spec/spec_helper.rb
+- tasks/console.rb
+- tasks/coverage.rb
+homepage: https://github.com/gdeoliveira/mtrack
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Group and track methods on classes and modules.
+test_files:
+- spec/lib/mtrack/core_spec.rb
+- spec/lib/mtrack/state/group_spec.rb
+- spec/lib/mtrack/state_spec.rb
+- spec/lib/mtrack/version_spec.rb
+- spec/spec_helper.rb