stateoscope 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4ed5f970d557641d7ba6584bd3c1f181ec3ba917
-  data.tar.gz: fe3a7d314f705d133f53b860c6be221de5eb5e61
+SHA256:
+  metadata.gz: 34c359ee93ffc4709384af57c9c6efb8c97c2fa736f3a94ede2e7dc7ad6ca8fa
+  data.tar.gz: f7f704ffaee3bda3a75734ecb5b1f5ccacfbacf824f2642f68e33328258d2718
 SHA512:
-  metadata.gz: 268c0876be618d84ff9986cd2bfb6cc708b33ff41250a0f61a715138f78f17844138c986444d64dbbbd2584f4ef76d3f3d2c5bb34669bf46597840849d25fbff
-  data.tar.gz: 8d754bb1a7d2048b2a4483d939d9614c6683ff71c3ba0ee6df45d8fb8ead814ea03935d4dff29b222d5a9e325f3cc4fda41d5b34f13b272aae5f6a20323447b7
+  metadata.gz: c88971ae8bf8291d08dc1a54ce992d157e196c614751ca744a4f4fe701f2125ad7fc0735e43de47bc5c7524a6dfa22f27ea6bb1d156e8d731bb6db46ba397ad2
+  data.tar.gz: 775982abd2df2c36cd14178396b89425e14f6ec4b3f1fdf8ac0ae9b3d969c4ba0f2b49f9109bf8a34131ea1b1024c4ab41d1b78bf2790f8b168de00c6ea636e0

data/.travis.yml

@@ -1,4 +1,17 @@
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.4.5
+  - 2.5.3
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9302884ead7bad6d1cc81026ba78b5cd8551024643cf14c72fe2d42eaaef36e6
+before_install:
+  - gem update --system
+  - gem install bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+cache: bundler

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# v0.1.2 (04.04.2019)
+
+Features:
+
+- add ability to mark current state
+- add ability to specify output format
+- add ability to specify output directory
+
+Bugfixes:
+
+- dependency updates
+
+
+# v0.1.1 (07.10.2015)
+
+Bugfixes:
+
+- fixed timestamp in generated filename
+
+
+# v0.1.0 (07.10.2015)
+
+Initial release

data/README.md

@@ -1,20 +1,38 @@
 # Stateoscope
 
+[![Build Status](https://travis-ci.org/padde/stateoscope.svg)](https://travis-ci.org/padde/stateoscope)
+[![Code Climate](https://codeclimate.com/github/padde/stateoscope/badges/gpa.svg)](https://codeclimate.com/github/padde/stateoscope)
+[![Test Coverage](https://codeclimate.com/github/padde/stateoscope/badges/coverage.svg)](https://codeclimate.com/github/padde/stateoscope/coverage)
+[![Inline docs](http://inch-ci.org/github/padde/stateoscope.svg?branch=master)](http://inch-ci.org/github/padde/stateoscope)
+[![Gem Version](https://badge.fury.io/rb/stateoscope.svg)](https://badge.fury.io/rb/stateoscope)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/stateoscope)
+
 Visualize State Machines using GraphViz
 
+## External Dependencies
+
+Stateoscope depends on [GraphViz](http://www.graphviz.org/) for generating the
+graphs. You need to make sure that GraphViz is properly installed on your system
+before you will be able to generate graphs. If you are on a Mac, you can install
+GraphViz via [Homebrew](http://brew.sh/)
+
+```
+$ brew install graphviz
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'stateoscope'
+gem 'stateoscope', '~> 0.1.2', group: :development
 ```
 
 And then execute:
 
     $ bundle
 
-## Usage
+## Using the rake task
 
 To generate a state machine visualization for your `Model`, run
 
@@ -29,14 +47,38 @@ of the state machine as second parameter
 rake 'stateoscope:visualize[Model,specific_state_machine]'
 ```
 
-In both cases, a PDF file containing the graph visualization will be saved to
+If you want to highlight a specific state of your state machine, add the name as a third argument.
+
+```ruby
+rake 'stateoscope:visualize[Order,order_state,delivered]'
+```
+
+In any case, a PDF file containing the graph visualization will be saved to
 the current directory.
 
-## Integrations
+## Using Stateoscope directly
+
+Stateoscope exposes a `visualize` method that allows for a more fine-grained and dynamic usage.
+
+Example:
+
+```ruby
+filename = Stateoscope.visualize(
+  Order,
+  state_machine_name: "order_state",
+  current_state: "delivered",
+  dir: Rails.root.join("public"), # default current directory
+  format: "png" # default "pdf", possible are all formats that GraphViz supports
+)
+
+# filename will be for example RAILS_ROOT/public/order_state-20191201145422.png
+```
 
-Stateoscope is currently integrated with the following state machine gems:
+## Adapters
 
-* [AASM](https://github.com/aasm/aasm)
+Stateoscope ships with adapters for the following state machine gems:
+
+- [AASM](https://github.com/aasm/aasm)
 
 ## Development
 
@@ -47,4 +89,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/padde/stateoscope.
-

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "stateoscope"
+require 'bundler/setup'
+require 'stateoscope'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/stateoscope.rb

@@ -1,18 +1,31 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'stateoscope/core_ext'
 require 'stateoscope/version'
-require 'stateoscope/integrations'
+require 'stateoscope/errors'
+require 'stateoscope/adapter'
 require 'stateoscope/visualizer'
 
 require 'stateoscope/railtie' if defined?(Rails)
 
 module Stateoscope
   def self.visualize(klass, options = {})
-    state_machine_name = options.fetch(:state_machine_name, nil)
-    integration = Integrations.new_for(klass, state_machine_name)
-    filename = options.fetch(:filename, filename_for(integration))
-    Visualizer.new(integration.graph).output(filename)
+    adapter = Adapter.new_for(klass, options[:state_machine_name])
+    adapter.build_graph
+
+    visualizer = Visualizer.new(adapter.graph)
+    visualizer.parse_graph(options[:current_state])
+
+    output_format = options.fetch(:format, 'pdf')
+    filename = filename_for(adapter, output_format)
+    filename = File.join(options[:dir], filename) if options[:dir].present?
+
+    visualizer.output(filename, output_format)
+    filename
   end
 
-  def self.filename_for(integration)
-    "#{integration.full_state_machine_name}-#{Time.now.utc.strftime('%Y%m%d%H%M%s')}"
+  def self.filename_for(adapter, output_format)
+    "#{adapter.full_state_machine_name}-#{Time.now.utc.strftime('%Y%m%d%H%M%S')}.#{output_format}"
   end
 end

data/lib/stateoscope/adapter.rb

@@ -0,0 +1,21 @@
+require 'stateoscope/adapter_registry'
+
+module Stateoscope
+  module Adapter
+    mattr_accessor :registry
+
+    self.registry = AdapterRegistry.new
+
+    def self.register(adapter)
+      registry.register(adapter)
+    end
+
+    def self.new_for(klass, state_machine_name)
+      adapter = registry.find!(klass, state_machine_name)
+      adapter.new(klass, state_machine_name)
+    end
+  end
+end
+
+require 'stateoscope/adapter/base'
+require 'stateoscope/adapter/aasm'

data/lib/stateoscope/{integrations → adapter}/aasm.rb

@@ -1,29 +1,20 @@
 module Stateoscope
-  module Integrations
-    class AASM < Struct.new(:klass, :state_machine_name)
-      def graph
-        graph = Graph.new
-
-        graph.initial_state = state_machine.initial_state.to_s
-
-        state_machine.states.each do |state|
-          graph.add_state(state.name.to_s)
-        end
-
-        state_machine.events.each do |event|
-          event.transitions.each do |transition|
-            graph.add_transition(transition.from.to_s, transition.to.to_s, event.name.to_s)
-          end
-        end
+  module Adapter
+    class AASM < Base
+      def self.handle?(klass, _state_machine_name)
+        klass.inherits_from?('::AASM')
+      end
 
+      def build_graph
+        add_initial_state
+        add_states
+        add_transitions
         graph.detect_final_states!
-
-        graph
       end
 
       def full_state_machine_name
         [
-          "aasm",
+          'aasm',
           klass.name,
           state_machine_name
         ].compact.join('-').dasherize
@@ -32,8 +23,28 @@ module Stateoscope
       private
 
       def state_machine
-        klass.public_send(:aasm, state_machine_name.presence)
+        klass.aasm(state_machine_name.presence)
+      end
+
+      def add_initial_state
+        graph.initial_state = state_machine.initial_state.to_s
+      end
+
+      def add_states
+        state_machine.states.each do |state|
+          graph.add_state(state.name.to_s)
+        end
+      end
+
+      def add_transitions
+        state_machine.events.each do |event|
+          event.transitions.each do |transition|
+            graph.add_transition(transition.from.to_s, transition.to.to_s, event.name.to_s)
+          end
+        end
       end
     end
+
+    register ::Stateoscope::Adapter::AASM
   end
 end

data/lib/stateoscope/adapter/base.rb

@@ -0,0 +1,26 @@
+require 'stateoscope/graph'
+
+module Stateoscope
+  module Adapter
+    class Base
+      attr_accessor :klass, :state_machine_name, :graph
+      def self.handle?(_klass, _state_machine_name)
+        fail AbstractMethodError
+      end
+
+      def initialize(klass, state_machine_name)
+        self.klass = klass
+        self.state_machine_name = state_machine_name
+        self.graph = Graph.new
+      end
+
+      def build_graph
+        fail AbstractMethodError
+      end
+
+      def full_state_machine_name
+        fail AbstractMethodError
+      end
+    end
+  end
+end

data/lib/stateoscope/adapter_registry.rb

@@ -0,0 +1,26 @@
+module Stateoscope
+  AdapterRegistry = Struct.new(:adapters) do
+    def initialize
+      self.adapters = []
+    end
+
+    def register(adapter)
+      adapters << adapter
+    end
+
+    def find(klass, state_machine_name)
+      adapters.find do |adapter|
+        adapter.handle?(klass, state_machine_name)
+      end
+    end
+
+    def find!(klass, state_machine_name)
+      adapter = find(klass, state_machine_name)
+      if adapter
+        adapter
+      else
+        fail MissingAdapterError, 'unsupported state machine implementation'
+      end
+    end
+  end
+end

data/lib/stateoscope/core_ext.rb

@@ -0,0 +1 @@
+require 'stateoscope/core_ext/class'

data/lib/stateoscope/core_ext/class.rb

@@ -0,0 +1,6 @@
+class Class
+  def inherits_from?(superclass_name)
+    return false unless const_defined?(superclass_name)
+    ancestors.include?(const_get(superclass_name))
+  end
+end

data/lib/stateoscope/errors.rb

@@ -0,0 +1,6 @@
+module Stateoscope
+  Error = Class.new(StandardError)
+
+  AbstractMethodError = Class.new(Error)
+  MissingAdapterError = Class.new(Error)
+end

data/lib/stateoscope/graph.rb

@@ -5,25 +5,25 @@ module Stateoscope
     attr_accessor :initial_state, :states, :final_states, :transitions
 
     def initialize
-      @states = []
-      @final_states = []
-      @transitions = []
+      self.states = []
+      self.final_states = []
+      self.transitions = []
     end
 
     def add_state(state)
-      @states << state
+      states << state
     end
 
-    def add_transition(from, to, event)
-      @transitions << OpenStruct.new(from: from, to: to, event: event)
+    def add_transition(from, to, event = nil)
+      transitions << OpenStruct.new(from: from, to: to, event: event)
     end
 
     def detect_final_states!
-      @final_states = states - transitions.map(&:from)
+      self.final_states = states - transitions.map(&:from)
     end
 
     def final_state?(state)
-      @final_states.include?(state)
+      final_states.include?(state)
     end
   end
 end

data/lib/stateoscope/version.rb

@@ -1,3 +1,3 @@
 module Stateoscope
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/stateoscope/visualizer.rb

@@ -1,40 +1,33 @@
 require 'ruby-graphviz'
 
 module Stateoscope
-  class Visualizer < Struct.new(:graph)
-    def initialize(graph)
-      super
-      parse_graph!
-    end
-
-    def parse_graph!
+  Visualizer = Struct.new(:graph) do
+    def parse_graph(current_state)
       @viz = GraphViz.new(:G, type: 'digraph')
       add_entry_point
-      add_states
+      add_states(current_state)
       add_entry_point_transition
       add_state_transitions
     end
 
-    def output(filename)
-      @viz.output(pdf: "#{filename}.pdf")
+    def output(filename, output_format)
+      @viz.output(output_format => filename)
     end
 
     private
 
     ENTRY_POINT = '__ENTRY_POINT__'
 
-    def filename
-      "#{integration.name}-#{state_machine_name}-#{Time.now.utc.strftime('%Y%m%d%H%M%S')}"
-    end
-
     def add_entry_point
       return unless graph.initial_state
       add_node(ENTRY_POINT, shape: 'circle', label: '', style: 'filled', color: 'black', fixedsize: true, width: 0.3)
     end
 
-    def add_states
+    def add_states(current_state)
       graph.states.each do |state|
-        add_node(state, peripheries: graph.final_state?(state) ? 2 : 1)
+        options = { peripheries: graph.final_state?(state) ? 2 : 1 }
+        options[:color] = 'green' if state == current_state
+        add_node(state, options)
       end
     end
 

data/lib/tasks/stateoscope.rake

@@ -1,8 +1,9 @@
 namespace :stateoscope do
   desc 'visualize state machine for a given class'
-  task :visualize, [:class, :state_machine_name] => :environment do |t, args|
-    fail ArgumentError 'missing required argument <class>' unless args[:class].present?
-    klass = args[:class].classify.constantize
-    Stateoscope.visualize(klass, state_machine_name: args[:state_machine_name])
+  task :visualize, %i[class state_machine_name current_state] => :environment do |_, args|
+    args = args.to_hash
+    klass = args.delete(:class)
+    raise ArgumentError, 'missing required argument <class>' if klass.blank?
+    Stateoscope.visualize(klass.classify.constantize, args)
   end
 end

data/stateoscope.gemspec

@@ -4,24 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stateoscope/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "stateoscope"
+  spec.name          = 'stateoscope'
   spec.version       = Stateoscope::VERSION
-  spec.authors       = ["Patrick Oscity"]
-  spec.email         = ["patrick.oscity@gmail.com"]
+  spec.authors       = ['Patrick Oscity']
+  spec.email         = ['patrick.oscity@gmail.com']
 
-  spec.summary       = %q{State Machine Visualizer}
-  spec.description   = %q{Visualize State Machines using GraphViz}
-  spec.homepage      = "https://github.com/padde/stateoscope"
-  spec.license       = "MIT"
+  spec.summary       = 'State Machine Visualizer'
+  spec.description   = 'Visualize State Machines using GraphViz'
+  spec.homepage      = 'https://github.com/padde/stateoscope'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "ruby-graphviz"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'ruby-graphviz'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stateoscope
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Patrick Oscity
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +68,48 @@ dependencies:
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -76,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,9 +140,14 @@ files:
 - bin/console
 - bin/setup
 - lib/stateoscope.rb
+- lib/stateoscope/adapter.rb
+- lib/stateoscope/adapter/aasm.rb
+- lib/stateoscope/adapter/base.rb
+- lib/stateoscope/adapter_registry.rb
+- lib/stateoscope/core_ext.rb
+- lib/stateoscope/core_ext/class.rb
+- lib/stateoscope/errors.rb
 - lib/stateoscope/graph.rb
-- lib/stateoscope/integrations.rb
-- lib/stateoscope/integrations/aasm.rb
 - lib/stateoscope/railtie.rb
 - lib/stateoscope/version.rb
 - lib/stateoscope/visualizer.rb
@@ -110,8 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: State Machine Visualizer

data/lib/stateoscope/integrations.rb

@@ -1,14 +0,0 @@
-require 'stateoscope/graph'
-require 'stateoscope/integrations/aasm'
-
-module Stateoscope
-  module Integrations
-    def self.new_for(klass, state_machine_name)
-      if klass.ancestors.include?(::AASM)
-        ::Stateoscope::Integrations::AASM.new(klass, state_machine_name)
-      else
-        fail NotImplementedError, "unsupported state machine implementation"
-      end
-    end
-  end
-end