mtrack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09f257cc34dc5d1126287a8d5086b567de5bb4be
+  data.tar.gz: 0131aac3c34421089a18246398b58ca2d69627dd
+SHA512:
+  metadata.gz: 3e477c84966256fa56a36de12e8031b3272e98f1980e6904cd0720fc8206491a38afd40c64e0ff259462e55b741291ab26e0c10477f96195f987e213b39f1641
+  data.tar.gz: a6b86548b5075ed830d586c12074e7edf2d1ca7c2f4d9dd12c2dbb993861247578f00002aaffd6033512937adcf97421e85b3eb374878279ec5333a8e1339d9a

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.buildpath
+.project

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1
+  - 2.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+addons:
+  code_climate:
+    repo_token: cc41eb6449075390a8bdb804fa3ff5865a7fbf22384fcd1757730b702eefdb0a

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) {|m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb") { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gabriel de Oliveira
+
+MIT License
+
+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/README.md

@@ -0,0 +1,190 @@
+# MTrack
+
+[![Gem Version](http://img.shields.io/gem/v/mtrack.svg)][gem]
+[![Build Status](http://img.shields.io/travis/gdeoliveira/mtrack.svg)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/gdeoliveira/mtrack.svg)][codeclimate]
+[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/gdeoliveira/mtrack.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/gdeoliveira/mtrack.svg?branch=master)][inch-ci]
+
+[gem]: https://rubygems.org/gems/mtrack
+[travis]: http://travis-ci.org/gdeoliveira/mtrack
+[codeclimate]: https://codeclimate.com/github/gdeoliveira/mtrack
+[inch-ci]: http://inch-ci.org/github/gdeoliveira/mtrack
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "mtrack"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mtrack
+
+## Usage
+
+To track a group of methods within a Module (or a Class).
+
+```ruby
+require "mtrack"
+
+module Stooges
+  def shemp; end
+
+  track_methods do
+    def curly; end
+    def larry; end
+    def moe; end
+  end
+end
+
+Stooges.tracked_methods  #=> #<Set: {:curly, :larry, :moe}>
+```
+
+Methods can be grouped using an optional name.
+
+```ruby
+require "mtrack"
+
+module Numbers
+  def zero; end
+
+  track_methods :integers do
+    track_methods :odd do
+      def one; end
+      def three; end
+    end
+
+    track_methods :even do
+      def two; end
+      def four; end
+    end
+  end
+end
+
+Numbers.tracked_methods :integers  #=> #<Set: {:one, :three, :two, :four}>
+Numbers.tracked_methods :odd       #=> #<Set: {:one, :three}>
+Numbers.tracked_methods :even      #=> #<Set: {:two, :four}>
+```
+
+Tracked methods can be carried to other Modules and Classes via inclusion and
+inheritance.
+
+```ruby
+# We're using the previously defined Stooges and Numbers modules here.
+
+class MyClass
+  include Stooges
+  include Numbers
+end
+
+class MySubClass < MyClass
+end
+
+MySubClass.tracked_methods            #=> #<Set: {:curly, :larry, :moe}>
+MySubClass.tracked_methods :integers  #=> #<Set: {:one, :three, :two, :four}>
+```
+
+## Example
+
+### Simple State Machine
+
+We'll create a simple state machine using MTrack. First, let's create an
+abstraction for the state machine.
+
+```ruby
+require "mtrack"
+
+class SimpleStateMachine
+  class << self
+    private
+
+    alias_method :allow_while, :track_methods
+
+    def actions(transitions)
+      transitions.each do |action, state|
+        define_method action, transition_implementation(action, state)
+      end
+    end
+
+    def transition_implementation(action, new_state)
+      proc do
+        if self.class.tracked_methods(state).include? action
+          self.state = new_state
+          state_changed action
+        else
+          state_not_changed action
+        end
+      end
+    end
+  end
+
+  def initialize(state)
+    self.state = state
+  end
+
+  private
+
+  attr_accessor :state
+end
+```
+
+And now we'll implement a box that can be either _locked_, _closed_ or _open_.
+
+```ruby
+class Box < SimpleStateMachine
+  def initialize
+    super :locked
+  end
+
+  allow_while(:locked) { actions :unlock => :closed }
+  allow_while(:closed) { actions :lock => :locked, :open => :open }
+  allow_while(:open) { actions :close => :closed }
+
+  def look
+    "The box is #{state}."
+  end
+
+  private
+
+  def state_changed(action)
+    "You #{action} the box."
+  end
+
+  def state_not_changed(action)
+    "You can't #{action} the box while it is #{state}!"
+  end
+end
+```
+
+A sample output for our box could be:
+
+```ruby
+box = Box.new  #=> #<Box:0x007f00f0be30c8 @state=:locked>
+box.look       #=> "The box is locked."
+box.open       #=> "You can't open the box while it is locked!"
+box.unlock     #=> "You unlock the box."
+box.look       #=> "The box is closed."
+box.open       #=> "You open the box."
+box.lock       #=> "You can't lock the box while it is open!"
+box.close      #=> "You close the box."
+box.lock       #=> "You lock the box."
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gdeoliveira/mtrack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Dir[File.join(File.dirname(__FILE__), "tasks", "**", "*.rb")].each do |file|
+  require file
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :coverage

data/lib/mtrack.rb

@@ -0,0 +1,4 @@
+require "mtrack/module_mixin"
+require "mtrack/version"
+
+Module.send(:include, MTrack::ModuleMixin)

data/lib/mtrack/core.rb

@@ -0,0 +1,79 @@
+require "mtrack/state"
+
+module MTrack
+
+  ##
+  # Implements the core tracking functionality of the gem by extending those
+  # Modules and Classes that use MTrack::ModuleMixin#track_methods. Additionally
+  # it will extend Modules and Classes that include a Module that is tracking
+  # methods and Classes that inherit from a Class that is tracking methods.
+  module Core
+
+    ##
+    # call-seq:
+    #   tracked_methods(group_name = nil) => set
+    #
+    # Returns a set containing the currently tracked methods. An optional
+    # +group_name+ parameter can be passed to get the tracked methods of groups
+    # othen than the default +nil+ group.
+    #
+    #   class C
+    #     track_methods :my_group do
+    #       def method_1; end
+    #       def method_2; end
+    #     end
+    #   end
+    #
+    #   C.tracked_methods :my_group  #=> #<Set: {:method_1, :method_2}>
+    def tracked_methods(group_name = nil)
+      @__mtrack__.tracked group_name
+    end
+
+    private
+
+    ##
+    # Sets this state as a super-state of the Class or Module that has included
+    # the current Module.
+    def included(submodule)
+      state = @__mtrack__
+      submodule.instance_eval do
+        if @__mtrack__.nil?
+          @__mtrack__ = State.new(state)
+          extend Core
+        else
+          @__mtrack__.add_super_state state
+        end
+      end
+    end
+
+    ##
+    # Sets this state as a super-state of the Class that has inherited from the
+    # current Class.
+    def inherited(subclass)
+      state = @__mtrack__
+      subclass.instance_eval { @__mtrack__ = State.new(state) }
+    end
+
+    ##
+    # Allows method +name+ to be displayed on #tracked_methods once again after
+    # being disabled by a call to #method_undefined.
+    def method_added(name)
+      @__mtrack__.delete_undefined name
+    end
+
+    ##
+    # Stops tracking method +name+ in the current Class or Module.
+    def method_removed(name)
+      @__mtrack__.delete_tracked name
+    end
+
+    ##
+    # Stops tracking method +name+ in the current Class or Module and prevents
+    # homonymous methods tracked in super-states from being displayed as
+    # #tracked_methods.
+    def method_undefined(name)
+      @__mtrack__.delete_tracked name
+      @__mtrack__.add_undefined name
+    end
+  end
+end

data/lib/mtrack/module_mixin.rb

@@ -0,0 +1,52 @@
+require "set"
+
+require "mtrack/core"
+require "mtrack/state"
+
+module MTrack
+
+  ##
+  # Provides the #track_methods method to all Classes and Modules by being mixed
+  # into the +Module+ class.
+  module ModuleMixin
+    private
+
+    ##
+    # call-seq:
+    #   track_methods(group_name = nil) => set
+    #   track_methods(group_name = nil) {|| ... } => set
+    #
+    # Sets up an MTrack::State instance for this Class or Module and extends it
+    # using MTrack::Core.
+    #
+    # If a block is provided all the methods defined within the block will be
+    # tracked under the optional +group_name+ parameter.
+    #
+    # Returns a set containing the methods that were defined within the block or
+    # an empty set otherwise.
+    #
+    #   class C
+    #     track_methods do
+    #       def method_1; end
+    #       track_methods(:inner_group_1) { def method_2; end }
+    #       def method_3; end
+    #     end
+    #   end  #=> #<Set: {:method_1, :method_2, :method_3}>
+    def track_methods(group_name = nil, &b)
+      @__mtrack__ ||= State.new
+      extend Core
+
+      if block_given?
+        old_methods = public_instance_methods(false)
+        begin
+          module_eval(&b)
+        ensure
+          tracked = (public_instance_methods(false) - old_methods).map(&:to_sym).to_set
+          @__mtrack__[group_name].merge_tracked tracked unless tracked.empty?
+        end
+      end
+
+      tracked || Set.new
+    end
+  end
+end

data/lib/mtrack/state.rb

@@ -0,0 +1,113 @@
+require "set"
+
+require "mtrack/state/group"
+
+module MTrack
+
+  ##
+  # Holds the internal state of tracked methods on Modules and Classes.
+  class State
+
+    ##
+    # call-seq:
+    #   new(super_state = nil) => new_state
+    #
+    # Creates a new State instance. An optional +super_state+ parameter can be
+    # passed that will be added to #super_states.
+    def initialize(super_state = nil)
+      self.groups = {}
+      self.super_states = super_state ? Set[super_state] : Set.new
+      self.undefined = Set.new
+    end
+
+    ##
+    # call-seq:
+    #   state[group_name] => group
+    #
+    # Returns a particular group in #groups. If the group doesn't exist it will
+    # be created.
+    def [](group_name)
+      groups[group_name] ||= Group.new
+    end
+
+    ##
+    # call-seq:
+    #   add_super_state(state) => state
+    #
+    # Adds a new state to #super_states.
+    def add_super_state(state)
+      super_states.add state
+      state
+    end
+
+    ##
+    # call-seq:
+    #   add_undefined(name) => name
+    #
+    # Adds +name+ to the #undefined methods set.
+    def add_undefined(name)
+      undefined.add name
+      name
+    end
+
+    ##
+    # call-seq:
+    #   delete_tracked(name) => name
+    #
+    # Removes method +name+ from all #groups.
+    def delete_tracked(name)
+      groups.each {|k, v| v.delete_tracked name }
+      name
+    end
+
+    ##
+    # call-seq:
+    #   delete_undefined(name) => name
+    #
+    # Removes +name+ from the #undefined methods set.
+    def delete_undefined(name)
+      undefined.delete name
+      name
+    end
+
+    ##
+    # call-seq:
+    #   tracked(group_name = nil) => set
+    #
+    # Returns a set containing the currently tracked methods. An optional
+    # +group_name+ parameter can be passed to get the tracked methods of groups
+    # othen than the default +nil+ group.
+    def tracked(group_name = nil)
+      ret_val = merge_super_states group_name
+      ret_val.merge groups[group_name].tracked unless groups[group_name].nil?
+      ret_val.subtract undefined
+    end
+
+    private
+
+    ##
+    # A Hash containing the groups defined in the current Class or Module.
+    attr_accessor :groups
+
+    ##
+    # A set of references to the states of inherited Classes and included
+    # Modules.
+    attr_accessor :super_states
+
+    ##
+    # A set of methods that are currently undefined on this Class or Module.
+    attr_accessor :undefined
+
+    ##
+    # call-seq:
+    #   merge_super_states(group_name) => set
+    #
+    # Returns a set containing all the methods being tracked for +group_name+
+    # by the #super_states.
+    def merge_super_states(group_name)
+      super_states.inject(Set.new) do |set, state|
+        set.merge state.tracked(group_name)
+      end
+    end
+  end
+end