katuv 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/CHANGELOG

@@ -0,0 +1,5 @@
+- 0.0.1 -> 0.0.2
+	* Brought most of the work under test.
+	* Reorganized and Refactored `Katuv::Node`
+	* Restructured the Vistior code to not automatically recurse. Should
+		re-implement with some kind of non-local exiting functionality.

data/Gemfile

@@ -1,9 +1,16 @@
 source 'https://rubygems.org'
 
+gem 'rake'
+
 gem 'rspec'
 gem 'rspec-spies'
+gem 'coveralls', require: false
+gem 'flay'
+gem 'flog'
+gem 'mutant'
 
 gem 'pry'
 
+
 # Specify your gem's dependencies in katuv.gemspec
 gemspec

data/NOTES.md

@@ -0,0 +1,50 @@
+# Random ideas
+
+- Make Katuv have it's own DSL, to specify dsls. eg:
+
+    katuv do
+      nonterminal 'foo' do
+        terminal 'bar'
+        nonterminal 'baz', name: false
+      end
+
+      nonterminal baz do
+        multiple 'quux'
+        multiple 'qwix'
+        nonterminal 'bang'
+      end
+
+      terminal 'quux'
+
+      nonterminal 'qwix' do
+        terminal 'rumplestiltskin'
+      end
+
+      nonterminal 'bang' do
+        nonterminal 'bang', allow_blank: true
+      end
+
+    end
+
+Which would build all the appropriate classes automatically for a DSL like:
+
+
+    foo 'name' do
+      bar 'name'
+      baz do
+        quux '1'
+        quux '2'
+        qwix do
+          rumplestiltskin 'yep'
+        end
+
+        bang do
+          bang do
+            bang
+          end
+        end
+      end
+    end
+
+- Bonus points if the above is self-hosting.
+- More points if it can generate code or operate 'in-memory'

data/README.md

@@ -1,4 +1,4 @@
-# Katuv
+# Katuv [![Gem Version](https://badge.fury.io/rb/katuv.png)](http://badge.fury.io/rb/katuv) [![Build Status](https://travis-ci.org/jfredett/katuv.png?branch=master)](http://travis-ci.org/jfredett/katuv) [![Code Climate](https://codeclimate.com/github/jfredett/katuv.png)](https://codeclimate.com/github/jfredett/katuv) [![Coverage Status](https://coveralls.io/repos/jfredett/katuv/badge.png?branch=master)](https://coveralls.io/r/jfredett/katuv)
 
 Katuv is a tool for defining and transforming Embedded Ruby DSLs (EDSLs). It
 provides a simple facility to define DSL components and their connections.

data/Rakefile

@@ -1 +1,35 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'run specs'
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = ["-c", "-f progress"]
+end
+
+task :default => :spec
+
+
+task :flog do
+  puts "#### FLOG ####"
+  system 'flog lib/*'
+  puts "##############"
+end
+
+task :flay do
+  puts "#### FLAY ####"
+  system 'flay lib/*'
+  puts "##############"
+end
+
+task :mutant, [:klass] do |_, args|
+  puts "#### MUTANT TESTING ####"
+  system "mutant -I lib -r katuv --rspec-full #{args[:name] || '::Katuv'}"
+  puts "########################"
+end
+
+task :metrics => [:flog, :flay]
+
+
+task :all => [:spec, :mutant, :metrics]

data/lib/katuv.rb

@@ -1,5 +1,12 @@
+module Katuv; end
+
 require "katuv/version"
 
-module Katuv
-  # Your code goes here...
-end
+require 'katuv/object_set'
+
+require 'katuv/visitor_behavior'
+require 'katuv/naming_behavior'
+require 'katuv/node_behavior'
+require 'katuv/dsl'
+
+require 'katuv/node'

data/lib/katuv/dsl.rb

@@ -0,0 +1,46 @@
+module Katuv
+  module DSL
+    def nonterminal(type)
+      raise "NonterminalInTerminalError" if terminal?
+      define_method(_type_to_method_name(type)) do |name=nil, opts={}, &block|
+      if children.has_key?(type) and children[type]
+        children[type].run(&block)
+      else
+        children[type] = type.new(name, opts.merge({parent: self}), &block)
+      end
+      children[type]
+      end
+    end
+
+    def terminal(type)
+      #should only allow one.
+      raise "InvalidNodeTypeError" unless type.terminal?
+      define_method(_type_to_method_name(type)) do |name=nil, opts={}, &block|
+      raise "TerminalAlreadySetError" if children.has_key?(type)
+      children[type] = type.new(name, opts.merge({parent: self}), &block)
+      end
+    end
+    def terminal!
+      define_singleton_method(:terminal?) { true }
+    end
+    def terminal?; false end
+
+    def multiple(type)
+      #should store an entry in #children that is a list of all the instances
+      #it sees of this type. eg, `file 'x'; file 'y' #=> children[File] = [File<@name=x>, File<@name=y>]
+      raise "InvalidNodeTypeError" unless type.terminal?
+      define_method(_type_to_method_name(type)) do |name, opts={}, &block|
+      children[type] ||= ObjectSet.new
+      children[type] << type.new(name, opts.merge({parent: self}), &block)
+      end
+    end
+
+    def _type_to_method_name(type)
+      if type.respond_to?(:name)
+        type.name
+      else
+        type.to_s
+      end.split('::').last.downcase
+    end
+  end
+end

data/lib/katuv/naming_behavior.rb

@@ -0,0 +1,22 @@
+module Katuv
+  module NamingBehavior
+    def name
+      @name ||= self.class.name
+    end
+
+    #this is terrible
+    def method_name
+      #get the classname
+      self.class.name.to_s.
+        #remove the module
+        split('::').last.
+        #convert FooBar -> _Foo_Bar
+        gsub(/[A-Z]/, '_\&').
+        #drop the leading _
+        sub(/^_/, '').
+        #downcase everything to get foo_bar
+        downcase
+    end
+
+  end
+end

data/lib/katuv/node.rb

@@ -1,114 +1,13 @@
-# Represents a single node in the AST of a project structure
 module Katuv
   module Node
     def self.included(base)
-      base.send(:include, InstanceMethods)
-      base.send(:extend, ClassMethods)
+      base.send(:include, VisitorBehavior)
       base.send(:include, Enumerable)
-    end
-
-    module InstanceMethods
-      #this is terrible
-      def method_name
-        #get the classname
-        self.class.name.
-          #remove the module
-          to_s.split('::').last.
-          #convert FooBar -> _Foo_Bar
-          gsub(/[A-Z]/, '_\&').
-          #drop the leading _
-          gsub(/^_/, '').
-          #downcase everything to get foo_bar
-          downcase.to_sym
-      end
-
-      def visit(visitor)
-        visitor.before_visit!(self)
-        visitor.call(self)
-
-        each do |c|
-          c.visit(visitor)
-        end
-
-        visitor.after_visit!(self)
-        nil
-      end
-
-      def run
-      end
-
-      def each(&block)
-        children.values.each(&block)
-      end
-
-      def children
-        @children ||= {}
-      end
-
-      def name
-        @name || self.class.name
-      end
-
-      def initialize(name = nil, opts = {}, &block)
-        @parent = opts[:parent]
-        @name = name
-        @opts = opts
-        instance_eval &block if block_given?
-      end
-      attr_reader :parent, :name
-
-      def terminal?
-        self.class.terminal?
-      end
-
-      def has_children?
-        children.any?
-      end
-    end
-
-    module ClassMethods
-      def nonterminal(type)
-        raise "NonterminalInTerminalError" if terminal?
-        define_method(_type_to_method_name(type)) do |name=nil, opts={}, &block|
-        if children.has_key?(type) and children[type]
-          children[type].run(&block)
-        else
-          children[type] = type.new(name, opts.merge({parent: self}), &block)
-        end
-        children[type]
-        end
-      end
-
-      def terminal(type)
-        #should only allow one.
-        raise "InvalidNodeTypeError" unless type.terminal?
-        define_method(_type_to_method_name(type)) do |name=nil, opts={}, &block|
-        raise "TerminalAlreadySetError" if children.has_key?(type)
-        children[type] = type.new(name, opts.merge({parent: self}), &block)
-        end
-      end
-      def terminal!
-        define_singleton_method(:terminal?) { true }
-      end
-      def terminal?; false end
 
-      def multiple(type)
-        #should store an entry in #children that is a list of all the instances
-        #it sees of this type. eg, `file 'x'; file 'y' #=> children[File] = [File<@name=x>, File<@name=y>]
-        raise "InvalidNodeTypeError" unless type.terminal?
-        define_method(_type_to_method_name(type)) do |name, opts={}, &block|
-        children[type] ||= ObjectSet.new
-        children[type] << type.new(name, opts.merge({parent: self}), &block)
-        end
-      end
+      base.send(:include, NamingBehavior)
+      base.send(:include, NodeBehavior)
 
-      def _type_to_method_name(type)
-        if type.respond_to?(:name)
-          type.name
-        else
-          type.to_s
-        end.split('::').last.downcase
-      end
+      base.send(:extend, DSL)
     end
   end
 end

data/lib/katuv/node_behavior.rb

@@ -0,0 +1,27 @@
+module Katuv
+  module NodeBehavior
+    def initialize(name = nil, opts = {}, &block)
+      @parent = opts[:parent]
+      @name = name
+      @opts = opts
+      instance_eval &block if block_given?
+    end
+    attr_reader :parent, :name
+
+    def terminal?
+      self.class.terminal?
+    end
+
+    def each(&block)
+      children.values.each(&block)
+    end
+
+    def children
+      @children ||= {}
+    end
+
+    def has_children?
+      children.any?
+    end
+  end
+end

data/lib/katuv/object_set.rb

@@ -0,0 +1,9 @@
+module Katuv
+  class ObjectSet < Array
+    def visit(visitor)
+      each do |c|
+        c.visit(visitor)
+      end
+    end
+  end
+end

data/lib/katuv/version.rb

@@ -1,3 +1,3 @@
 module Katuv
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/katuv/visitor_behavior.rb

@@ -0,0 +1,16 @@
+module Katuv
+  module VisitorBehavior
+    def visit(visitor)
+      visitor.before(self) if visitor.respond_to? :before
+
+      if visitor.respond_to? method_name
+        visitor.send(method_name.to_sym, self)
+      else
+        visitor.unknown(self)
+      end
+
+      visitor.after(self) if visitor.respond_to? :after
+      nil
+    end
+  end
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'The Katuv DSL' do
+  before :all do
+    class Example
+    end
+  end
+  subject { Example }
+
+  context 'before inclusion' do
+    describe 'api' do
+      it { should_not respond_to :terminal }
+      it { should_not respond_to :nonterminal }
+      it { should_not respond_to :multiple }
+    end
+  end
+
+  context 'after inclusion' do
+    before do
+      class Example
+        include Katuv::Node
+      end
+    end
+
+    describe 'api' do
+      it { should respond_to :terminal }
+      it { should respond_to :nonterminal }
+      it { should respond_to :multiple }
+    end
+  end
+end

data/spec/node_spec.rb

@@ -1 +1,62 @@
 require 'spec_helper'
+
+describe Katuv::Node do
+  before :all do
+    class ExampleTerminal
+      include Katuv::Node
+      terminal!
+    end
+
+    class ExampleNonterminal
+      include Katuv::Node
+
+      terminal ExampleTerminal
+      nonterminal ExampleNonterminal
+    end
+
+    class Example
+      include Katuv::Node
+      terminal ExampleTerminal
+      nonterminal ExampleNonterminal
+    end
+  end
+  after :all do
+    Object.send(:remove_const, :Example)
+    Object.send(:remove_const, :ExampleTerminal)
+    Object.send(:remove_const, :ExampleNonterminal)
+  end
+
+  describe 'Example' do
+    subject { Example.new }
+    it_should_behave_like 'a nameable class'
+    it_should_behave_like 'a class with the naming behavior'
+    it_should_behave_like 'a visitable class'
+    it_should_behave_like 'a class with the visitable behavior'
+
+    its(:method_name) { should == "example" }
+  end
+
+  describe 'ExampleTerminal' do
+    subject { ExampleTerminal.new }
+
+    it_should_behave_like 'a nameable class'
+    it_should_behave_like 'a class with the naming behavior'
+    it_should_behave_like 'a visitable class'
+    it_should_behave_like 'a class with the visitable behavior'
+
+    its(:method_name) { should == "example_terminal" }
+
+    it { should be_terminal }
+  end
+
+  describe 'ExampleNonterminal' do
+    subject { ExampleNonterminal.new }
+
+    it_should_behave_like 'a nameable class'
+    it_should_behave_like 'a class with the naming behavior'
+    it_should_behave_like 'a visitable class'
+    it_should_behave_like 'a class with the visitable behavior'
+
+    its(:method_name) { should == "example_nonterminal" }
+  end
+end

data/spec/object_set_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Katuv::ObjectSet do
+  it { should respond_to :visit }
+end

data/spec/shared/naming_behavior_examples.rb

@@ -0,0 +1,11 @@
+shared_examples_for 'a nameable class' do
+  its(:class) { should respond_to :name }
+end
+
+shared_examples_for 'a class with the naming behavior' do
+  it { should respond_to :name }
+  it { should respond_to :method_name }
+
+  its(:method_name) { should_not =~ /[A-Z]/     } #no capitals
+  its(:method_name) { should_not =~ /[\t\n\r ]/ } #no spaces
+end

data/spec/shared/visitor_behavior_examples.rb

@@ -0,0 +1,165 @@
+shared_examples_for 'a visitable class' do
+  it { should respond_to :each }
+  it { should respond_to :method_name }
+end
+
+shared_examples_for 'a class with the visitable behavior' do
+  let(:visitor) { double('visitor') }
+  before { visitor.stub(:unknown) }
+
+  context 'with before hook' do
+    before { visitor.stub(:before) }
+
+    it 'calls the before hook' do
+      subject.visit(visitor)
+      visitor.should have_received :before
+    end
+
+    context 'with after hook' do
+      before { visitor.stub(:after) }
+
+      it 'calls the after hook' do
+        subject.visit(visitor)
+        visitor.should have_received :after
+      end
+
+      context 'with class-dispatch method defined' do
+        before { visitor.stub(subject.method_name.to_sym) }
+
+        it 'calls the appropriate class method' do
+          subject.visit(visitor)
+          visitor.should have_received subject.method_name.to_sym
+        end
+
+        it "doesn't call the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should_not have_received :unknown
+        end
+      end
+
+      context 'with no class-dispatch method defined' do
+        before { visitor.stub(:unknown) }
+
+        it "calls the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should have_received :unknown
+        end
+
+        it "doesn't call the class-dispatch method" do
+          subject.visit(visitor)
+          visitor.should_not have_received subject.method_name.to_sym
+        end
+      end
+    end
+
+    context 'without after hook' do
+      it 'calls the after hook' do
+        subject.visit(visitor)
+        visitor.should_not have_received :after
+      end
+
+      context 'with class-dispatch method defined' do
+        before { visitor.stub(subject.method_name.to_sym) }
+
+        it 'calls the appropriate class method' do
+          subject.visit(visitor)
+          visitor.should have_received subject.method_name.to_sym
+        end
+
+        it "doesn't call the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should_not have_received :unknown
+        end
+      end
+
+      context 'with no class-dispatch method defined' do
+        it "calls the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should have_received :unknown
+        end
+
+        it "doesn't call the class-dispatch method" do
+          subject.visit(visitor)
+          visitor.should_not have_received subject.method_name.to_sym
+        end
+      end
+    end
+  end
+
+  context 'without before hook' do
+    it 'calls the before hook' do
+      subject.visit(visitor)
+      visitor.should_not have_received :before
+    end
+
+    context 'with after hook' do
+      before { visitor.stub(:after) }
+
+      it 'calls the after hook' do
+        subject.visit(visitor)
+        visitor.should have_received :after
+      end
+
+      context 'with class-dispatch method defined' do
+        before { visitor.stub(subject.method_name.to_sym) }
+
+        it 'calls the appropriate class method' do
+          subject.visit(visitor)
+          visitor.should have_received subject.method_name.to_sym
+        end
+
+        it "doesn't call the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should_not have_received :unknown
+        end
+      end
+
+      context 'with no class-dispatch method defined' do
+
+        it "calls the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should have_received :unknown
+        end
+        it "doesn't call the class-dispatch method" do
+          subject.visit(visitor)
+          visitor.should_not have_received subject.method_name.to_sym
+        end
+
+      end
+    end
+
+    context 'without after hook' do
+      it 'does not call the after hook' do
+        subject.visit(visitor)
+        visitor.should_not have_received :after
+      end
+
+      context 'with class-dispatch method defined' do
+        before { visitor.stub(subject.method_name.to_sym) }
+
+        it 'calls the appropriate class method' do
+          subject.visit(visitor)
+          visitor.should have_received subject.method_name.to_sym
+        end
+
+        it "doesn't call the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should_not have_received :unknown
+        end
+      end
+
+      context 'with no class-dispatch method defined' do
+
+        it "calls the 'unknown' catchall method" do
+          subject.visit(visitor)
+          visitor.should have_received :unknown
+        end
+
+        it "doesn't call the class-dispatch method" do
+          subject.visit(visitor)
+          visitor.should_not have_received subject.method_name.to_sym
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ require 'katuv'
 
 require 'rspec-spies'
 
+require 'coveralls'
+Coveralls.wear!
+
 #include helpers
 Dir["./spec/helpers/*.rb"].each { |file| require file }
 

metadata

@@ -2,14 +2,14 @@
 name: katuv
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joe Fredette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-24 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies: []
 description: A tool for parsing and transforming internal Ruby DSLs
 email:
@@ -22,10 +22,16 @@ files:
   LmdpdGlnbm9yZQ==
 - !binary |-
   LnJ2bXJj
+- !binary |-
+  LnRyYXZpcy55bWw=
+- !binary |-
+  Q0hBTkdFTE9H
 - !binary |-
   R2VtZmlsZQ==
 - !binary |-
   TElDRU5TRS50eHQ=
+- !binary |-
+  Tk9URVMubWQ=
 - !binary |-
   UkVBRE1FLm1k
 - !binary |-
@@ -34,12 +40,30 @@ files:
   a2F0dXYuZ2Vtc3BlYw==
 - !binary |-
   bGliL2thdHV2LnJi
+- !binary |-
+  bGliL2thdHV2L2RzbC5yYg==
+- !binary |-
+  bGliL2thdHV2L25hbWluZ19iZWhhdmlvci5yYg==
 - !binary |-
   bGliL2thdHV2L25vZGUucmI=
+- !binary |-
+  bGliL2thdHV2L25vZGVfYmVoYXZpb3IucmI=
+- !binary |-
+  bGliL2thdHV2L29iamVjdF9zZXQucmI=
 - !binary |-
   bGliL2thdHV2L3ZlcnNpb24ucmI=
+- !binary |-
+  bGliL2thdHV2L3Zpc2l0b3JfYmVoYXZpb3IucmI=
+- !binary |-
+  c3BlYy9kc2xfc3BlYy5yYg==
 - !binary |-
   c3BlYy9ub2RlX3NwZWMucmI=
+- !binary |-
+  c3BlYy9vYmplY3Rfc2V0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9zaGFyZWQvbmFtaW5nX2JlaGF2aW9yX2V4YW1wbGVzLnJi
+- !binary |-
+  c3BlYy9zaGFyZWQvdmlzaXRvcl9iZWhhdmlvcl9leGFtcGxlcy5yYg==
 - !binary |-
   c3BlYy9zcGVjX2hlbHBlci5yYg==
 homepage: ''
@@ -49,17 +73,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2002549777813010636
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2002549777813010636
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -67,7 +97,15 @@ signing_key:
 specification_version: 3
 summary: A tool for parsing and transforming internal Ruby DSLs
 test_files:
+- !binary |-
+  c3BlYy9kc2xfc3BlYy5yYg==
 - !binary |-
   c3BlYy9ub2RlX3NwZWMucmI=
+- !binary |-
+  c3BlYy9vYmplY3Rfc2V0X3NwZWMucmI=
+- !binary |-
+  c3BlYy9zaGFyZWQvbmFtaW5nX2JlaGF2aW9yX2V4YW1wbGVzLnJi
+- !binary |-
+  c3BlYy9zaGFyZWQvdmlzaXRvcl9iZWhhdmlvcl9leGFtcGxlcy5yYg==
 - !binary |-
   c3BlYy9zcGVjX2hlbHBlci5yYg==