typist 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2757d8cd18bfb8ebf6112c05e260f20805f6fb4d
-  data.tar.gz: b5a017f46fba7063f1d8661bfadc2dca4876f0bd
+  metadata.gz: 17bc1b93c362a0acb4e9a516fe1cb6c85a8c12a3
+  data.tar.gz: 3cd4d3c01a379011988c50e9031a84a1925ecaec
 SHA512:
-  metadata.gz: 175cca390f72642c375d281d836c90a38bbad5bb774049babbb17b3a626a2e74fc1fe51971cb6af2549f867dad42027cfdb12ef33d37728077b0bf8cccc96086
-  data.tar.gz: e0502bdfa7442b48ae9a7baae0985c4f49c353bbeedcccf759f03e46755fbd18cc3f81573878803c06c42d1a396e414295fd66b6149d20af74ec799c01d0d6ee
+  metadata.gz: eb13350571688260b0f45e3b7892d3a9208f213adac413d156f1ee42688d9d15731c5f8402d1059d21e10aaca32b3ca9a38f406de697b1ecff034533baf5cbbe
+  data.tar.gz: c737d01ea3eb776eb4fcc337ca00638cc6a27d53ad2e096f0be98cefb8ca6fb1cdc134dc106802b3aac963a3abec7dab4ab6311d0df78f7dcf75d2740a3ef2b6

data/README.md

@@ -1,5 +1,6 @@
 # typist
 
+[![Gem Version](https://badge.fury.io/rb/typist.png)](http://badge.fury.io/rb/typist)
 [![Build Status](https://travis-ci.org/nahiluhmot/typist.png?branch=master)](https://travis-ci.org/nahiluhmot/typist)
 [![Code Climate](https://codeclimate.com/github/nahiluhmot/typist.png)](https://codeclimate.com/github/nahiluhmot/typist)
 
@@ -113,7 +114,7 @@ Example usage:
 
 ```ruby
 leaf = Tree.leaf
-node = Tree.node(:value => 'a', :left => Tree.leaf, right => Tree.leaf)
+node = Tree.node(:value => 'a', :left => Tree.leaf, :right => Tree.leaf)
 
 leaf.contains?('a')
 # => false

data/lib/typist.rb

@@ -1,11 +1,12 @@
 # This is the top level module for the gem, used as a namespace and as a
 # location for high-level functions.
 module Typist
-  autoload :Constructor, 'typist/constructor'
-  autoload :Data, 'typist/data'
-  autoload :Error, 'typist/error'
-  autoload :Func, 'typist/func'
-  autoload :Util, 'typist/util'
+  require 'typist/constructor'
+  require 'typist/data'
+  require 'typist/data_func'
+  require 'typist/error'
+  require 'typist/func'
+  require 'typist/util'
 
   # Define a new data type.
   def data(*args, &block)

data/lib/typist/data.rb

@@ -1,6 +1,6 @@
 # Instances of this class may be included like a module.
 class Typist::Data
-  attr_reader :name, :constructors, :funcs, :block
+  attr_reader :name, :constructors, :funcs, :data_funcs, :block
 
   # Create a new data type with the given name. The block will be evaluated in
   # the context of the new instance.
@@ -8,6 +8,7 @@ class Typist::Data
     @name = name
     @constructors = []
     @funcs = []
+    @data_funcs = []
     @block = block
   end
 
@@ -21,6 +22,11 @@ class Typist::Data
     funcs << Typist::Func.new(*args, &block)
   end
 
+  # Define a function whose receiver is the data type.
+  def data_func(*args, &block)
+    data_funcs << Typist::DataFunc.new(*args, &block)
+  end
+
   # Get the module that is defined.
   def get_module
     @module ||= Module.new
@@ -33,6 +39,7 @@ class Typist::Data
       instance_eval(&block) unless block.nil?
       constructors.each { |constructor| constructor.define!(context) }
       funcs.each { |func| func.define!(context) }
+      data_funcs.each { |func| func.define!(context) }
     end
   end
 end

data/lib/typist/data_func.rb

@@ -0,0 +1,15 @@
+# A DataFunc is Typist's equivalent of a class method.
+class Typist::DataFunc
+  attr_reader :name, :block
+
+  # Create a new DataFunc.
+  def initialize(name, &block)
+    @name = name
+    @block = block
+  end
+
+  # Define a DataFunc in the given context.
+  def define!(context)
+    context.define_singleton_method(name, &block)
+  end
+end

data/lib/typist/version.rb

@@ -1,4 +1,4 @@
 # This file holds version information for the gem.
 module Typist
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lib/typist/constructor_spec.rb

@@ -5,11 +5,11 @@ describe Typist::Constructor do
     subject { described_class.new(:Node, :value, :left, :right) }
 
     it 'sets the @name instance variable' do
-      subject.name.should == :Node
+      expect(subject.name).to eq(:Node)
     end
 
     it 'sets the @vars instance variable' do
-      subject.vars.should == [:value, :left, :right]
+      expect(subject.vars).to eq([:value, :left, :right])
     end
   end
 
@@ -17,7 +17,7 @@ describe Typist::Constructor do
     subject { described_class.new(:Leaf) }
 
     it 'returns a Class' do
-      subject.get_class.should be_a Class
+      expect(subject.get_class).to be_a(Class)
     end
   end
 
@@ -33,19 +33,19 @@ describe Typist::Constructor do
       }
 
       it 'has each @var as an accessor' do
-        instance.should respond_to(:arg1)
-        instance.should respond_to(:arg2)
-        instance.should_not respond_to(:arg3)
+        expect(instance).to respond_to((:arg1))
+        expect(instance).to respond_to((:arg2))
+        expect(instance).to_not respond_to(:arg3)
       end
 
       it 'accepts a hash in its initializer which sets instance variables' do
-        instance.instance_variable_get(:@arg1).should == ?a
-        instance.instance_variable_get(:@arg2).should == ?b
-        instance.instance_variable_get(:@arg3).should == ?c
+        expect(instance.instance_variable_get(:@arg1)).to eq('a')
+        expect(instance.instance_variable_get(:@arg2)).to eq('b')
+        expect(instance.instance_variable_get(:@arg3)).to eq('c')
       end
 
       it 'includes the given module' do
-        subject.get_class.ancestors.should include(mod)
+        expect(subject.get_class.ancestors).to include(mod)
       end
     end
 
@@ -53,9 +53,9 @@ describe Typist::Constructor do
       let(:instance) { mod.test_class(:arg1 => 1, :arg2 => 2) }
 
       it 'defines a method to create an instance of the defined class' do
-        instance.should be_a mod::TestClass
-        instance.arg1.should == 1
-        instance.arg2.should == 2
+        expect(instance).to be_a(mod::TestClass)
+        expect(instance.arg1).to eq(1)
+        expect(instance.arg2).to eq(2)
       end
     end
   end

data/spec/lib/typist/data_func_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Typist::DataFunc do
+  describe '#initialize' do
+    let(:name) { :test_func }
+    let(:block) { proc { |x| x.succ } }
+    subject { Typist::DataFunc.new(name, &block) }
+
+    it 'creates a new DataFunc with the given name and block' do
+      expect(subject.name).to eq(name)
+      expect(subject.block.call(1)).to eq(2)
+    end
+  end
+
+  describe '#define!' do
+    let(:name) { :chomp }
+    let(:block) { proc { |str| str.chomp } }
+    let(:mod) { Module.new }
+    subject { Typist::DataFunc.new(name, &block) }
+
+    before { subject.define!(mod) }
+
+    it 'defines its @name on the given module' do
+      expect(mod.chomp("test\n")).to eq('test')
+    end
+  end
+end

data/spec/lib/typist/data_spec.rb

@@ -6,15 +6,15 @@ describe Typist::Data do
       subject { described_class.new(:Test) }
 
       it 'sets the @name' do
-        subject.name.should == :Test
+        expect(subject.name).to eq(:Test)
       end
 
       it 'sets the @constructors to []' do
-        subject.constructors.should be_empty
+        expect(subject.constructors).to be_empty
       end
 
       it 'sets the @funcs to []' do
-        subject.funcs.should be_empty
+        expect(subject.funcs).to be_empty
       end
     end
 
@@ -34,7 +34,7 @@ describe Typist::Data do
       expect { subject.constructor(:Leaf) }
         .to change { subject.constructors.length }.by(1)
 
-      subject.constructors.should be_all { |constructor|
+      expect(subject.constructors).to be_all { |constructor|
         constructor.is_a?(Typist::Constructor)
       }
     end
@@ -43,12 +43,25 @@ describe Typist::Data do
   describe '#func' do
     subject { described_class.new(:Trie) }
 
-    it 'adds a constructor' do
+    it 'adds a func' do
       expect { subject.func(:empty) }
         .to change { subject.funcs.length }.by(1)
 
-      subject.funcs.should be_all { |funcs|
-        funcs.is_a?(Typist::Func)
+      expect(subject.funcs).to be_all { |func|
+        func.is_a?(Typist::Func)
+      }
+    end
+  end
+
+  describe '#data_func' do
+    subject { described_class.new(:SomeTree) }
+
+    it 'adds a data func' do
+      expect { subject.data_func(:test) { } }
+        .to change { subject.data_funcs.length }.by(1)
+
+      expect(subject.data_funcs).to be_all { |data_func|
+        data_func.is_a?(Typist::DataFunc)
       }
     end
   end
@@ -57,7 +70,7 @@ describe Typist::Data do
     subject { described_class.new(:Set) }
 
     it 'returns a module' do
-      subject.get_module.should be_a(Module)
+      expect(subject.get_module).to be_a(Module)
     end
   end
 
@@ -67,6 +80,10 @@ describe Typist::Data do
         constructor :Leaf
         constructor :Node, :value, :left, :right
 
+        data_func :singleton do |value|
+          Tree.node(:value => value, :left => Tree.leaf, :right => Tree.leaf)
+        end
+
         func :empty? do
           match(Tree::Leaf) { true }
           match(Tree::Node) { false }
@@ -116,29 +133,34 @@ describe Typist::Data do
     }
 
     it 'defines convenience methods' do
-      Tree.should respond_to(:node)
-      Tree.should respond_to(:leaf)
+      expect(Tree).to respond_to(:node)
+      expect(Tree).to respond_to(:leaf)
     end
 
     it 'defines each constructor' do
-      Tree::Node.should include(Tree)
-      Tree::Leaf.should include(Tree)
+      expect(Tree::Node.ancestors).to include(Tree)
+      expect(Tree::Leaf.ancestors).to include(Tree)
+
+      expect(node.value).to eq(4)
+      expect(node.left).to eq(Tree.leaf)
+      expect(node.right).to eq(Tree.leaf)
+    end
 
-      node.value.should == 4
-      node.left.should == Tree.leaf
-      node.right.should == Tree.leaf
+    it 'defines each data function' do
+      expect(Tree.singleton(1))
+        .to eq(Tree.node(:value => 1, :left => Tree.leaf, :right => Tree.leaf))
     end
 
     it 'defines functions on the constructors' do
-      leaf.should be_empty
-      node.should_not be_empty
+      expect(leaf).to be_empty
+      expect(node).to_not be_empty
 
-      leaf.contains?(4).should be_false
-      node.contains?(4).should be_true
-      node.contains?(5).should be_false
+      expect(leaf.contains?(4)).to be_false
+      expect(node.contains?(4)).to be_true
+      expect(node.contains?(5)).to be_false
 
-      leaf.size.should == 0
-      node.size.should == 1
+      expect(leaf.size).to eq(0)
+      expect(node.size).to eq(1)
     end
   end
 end

data/spec/lib/typist/func_spec.rb

@@ -6,11 +6,11 @@ describe Typist::Func do
       subject { described_class.new(:a_function) }
 
       it 'sets the @name instance variable to the first argument' do
-        subject.name.should == :a_function
+        expect(subject.name).to eq(:a_function)
       end
 
       it 'has no matches intially' do
-        subject.matches.should be_empty
+        expect(subject.matches).to be_empty
       end
     end
 
@@ -29,12 +29,11 @@ describe Typist::Func do
     before { subject.match(Fixnum) { :it_works } }
 
     it 'adds that to the @matches hash' do
-      subject.matches[Fixnum].call.should == :it_works
+      expect(subject.matches[Fixnum].call).to eq(:it_works)
     end
   end
 
   describe '#define!' do
-
     context 'when an invalid class is matched against' do
       subject {
         module BaseModule; end
@@ -75,7 +74,7 @@ describe Typist::Func do
 
       context 'when a subclass does match against the function' do
         it 'evaluates its match' do
-          Matches.new.alpha.should == 'qt3.14'
+          expect(Matches.new.alpha).to eq('qt3.14')
         end
       end
     end

data/spec/lib/typist/util_spec.rb

@@ -13,7 +13,7 @@ describe Typist::Util do
     }
 
     it 'converts CamelCase Strings to snake_case' do
-      hash.each { |camel, snake| subject.snakeify(camel).should == snake }
+      expect(hash).to be_all { |camel, snake| subject.snakeify(camel) == snake }
     end
   end
 end

data/spec/lib/typist_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe Typist do
-  it { should be_a Module }
-
   describe '#data' do
     before do
       extend Typist
@@ -19,13 +17,13 @@ describe Typist do
     end
 
     it 'defines a data type' do
-      Boolean.should be_a Module
+      expect(Boolean).to be_a(Module)
 
-      Boolean.false.should be_a Boolean::False
-      Boolean.true.should be_a Boolean::True
+      expect(Boolean.false).to be_a(Boolean::False)
+      expect(Boolean.true).to be_a(Boolean::True)
 
-      Boolean.false.to_i.should == 0
-      Boolean.true.to_i.should == 1
+      expect(Boolean.false.to_i).to eq(0)
+      expect(Boolean.true.to_i).to eq(1)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,12 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+# Submit metrics to code climate.
+unless ENV['CODECLIMATE_REPO_TOKEN'].nil?
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+require 'pry'
 require 'rspec'
 require 'typist'
 

data/typist.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'cane'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'codeclimate-test-reporter'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Hulihan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !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'
 description: Algebraic data types for Ruby
 email:
 - hulihan.tom159@gmail.com
@@ -81,11 +95,13 @@ files:
 - lib/typist.rb
 - lib/typist/constructor.rb
 - lib/typist/data.rb
+- lib/typist/data_func.rb
 - lib/typist/error.rb
 - lib/typist/func.rb
 - lib/typist/util.rb
 - lib/typist/version.rb
 - spec/lib/typist/constructor_spec.rb
+- spec/lib/typist/data_func_spec.rb
 - spec/lib/typist/data_spec.rb
 - spec/lib/typist/func_spec.rb
 - spec/lib/typist/util_spec.rb
@@ -118,6 +134,7 @@ specification_version: 4
 summary: Algebraic data types for Ruby
 test_files:
 - spec/lib/typist/constructor_spec.rb
+- spec/lib/typist/data_func_spec.rb
 - spec/lib/typist/data_spec.rb
 - spec/lib/typist/func_spec.rb
 - spec/lib/typist/util_spec.rb