unidata 0.0.5 → 0.0.6

data/README.md

@@ -1,4 +1,4 @@
-UniData ORM [![Build Status](https://secure.travis-ci.org/jisraelsen/unidata.png?branch=master)](http://travis-ci.org/jisraelsen/unidata)
+UniData ORM [![Build Status](https://secure.travis-ci.org/jisraelsen/unidata.png?branch=master)](http://travis-ci.org/jisraelsen/unidata) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jisraelsen/unidata)
 ===========
 
 A simple ORM for Rocket's UniData database.
@@ -21,7 +21,32 @@ Or install it yourself as:
 Usage
 -----
 
-Model definition:
+### Connecting to Unidata:
+
+```ruby
+Unidata.prepare_connection(
+  :user     => "admin",
+  :password => "secret",
+  :host     => "localhost",
+  :data_dir => "/usr/uv/db"
+)
+
+Unidata.open_connection do
+  # interact with Unidata here
+end
+```
+
+Or, you can manually open and close the connection yourself.
+
+```ruby
+Unidata.open_connection
+
+# interact with Unidata here
+
+Unidata.close_connection
+```
+
+### Defining models:
 
 ```ruby
 class Product < Unidata::Model
@@ -34,7 +59,7 @@ class Product < Unidata::Model
 end
 ```
 
-Creating records:
+### Creating records:
 
 ```ruby
 thingamajig = Product.new(
@@ -53,13 +78,13 @@ whatsit.available = Date.today
 whatsit.save
 ```
 
-Record retrieval:
+### Retrieving records:
 
 ```ruby
 product = Product.find(12345)
 ```
 
-Checking if a record exists:
+Or, you can just check if a record exists:
 
 ```ruby
 Product.exists?(12345)

data/lib/unidata.rb

@@ -1,6 +1,7 @@
 require 'java'
 require 'unidata/asjava.jar'
 require 'unidata/extensions'
+require 'unidata/select_list'
 require 'unidata/connection'
 require 'unidata/field'
 require 'unidata/model'

data/lib/unidata/connection.rb

@@ -24,6 +24,13 @@ module Unidata
       @session = nil
     end
 
+    def select(filename, condition="", list_number=0)
+      command = "SELECT #{filename} TO #{list_number}"
+      command << " WITH #{condition}" unless condition.empty?
+      @session.command(command).exec
+      SelectList.new(@session.select_list list_number)
+    end
+
     def exists?(filename, record_id)
       exists = false
 

data/lib/unidata/model.rb

@@ -23,6 +23,7 @@ module Unidata
       def field(index, name, type=String, options={})
         fields[name.to_sym] = Field.new(index, name, type, options)
         define_attribute_accessor(name)
+        define_attribute_finder(name)
       end
 
       def to_unidata(instance)
@@ -64,6 +65,13 @@ module Unidata
         end
       end
 
+      def find_by(name, value)
+        field_number = "F#{fields[name.to_sym].index.first}"
+        connection.select(filename, "#{field_number} EQ \"#{value}\"").map do |id|
+          find(id)
+        end
+      end
+
       private
       def define_attribute_accessor(attribute_name)
         class_eval <<-end_eval
@@ -76,6 +84,14 @@ module Unidata
           end
         end_eval
       end
+
+      def define_attribute_finder(attribute_name)
+        instance_eval <<-end_eval
+          def find_by_#{attribute_name}(value)
+            find_by(:#{attribute_name}, value)
+          end
+        end_eval
+      end
     end
 
     def initialize(attributes={})

data/lib/unidata/select_list.rb

@@ -0,0 +1,31 @@
+module Unidata
+  class SelectList
+    include Enumerable
+
+    def initialize(uniselect_list, should_cache=false)
+      @uniselect_list = uniselect_list
+      @should_cache = should_cache
+      @cache = []
+      @exhausted = false
+    end
+
+    def each &block
+      return [] if @exhausted && !@should_cache
+      if @exhausted
+        @cache.each &block
+      else
+        iterate &block
+      end
+    end
+
+    private
+
+    def iterate
+      until (id = @uniselect_list.next.to_s).empty? do
+        @cache << id if @should_cache
+        yield id
+      end
+      @exhausted = true
+    end
+  end
+end

data/lib/unidata/version.rb

@@ -1,3 +1,3 @@
 module Unidata
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/spec_helper.rb

@@ -22,5 +22,15 @@ def package_local_constructor klass,*values
   raise TypeError,"found no matching constructor for " + klass.to_s + "(" + value.class + ")"
 end
 
+class StubUniSelectList
+  def initialize(items)
+    @items = items.map{|item| item.to_s}
+  end
+
+  def next
+    @items.shift || ""
+  end
+end
+
 RSpec.configure do |config|
 end

data/spec/unidata/connection_spec.rb

@@ -71,6 +71,33 @@ describe Unidata::Connection do
     end
   end
 
+  describe '#select' do
+    before(:each) do
+      @session.stub(:command).and_return(double.as_null_object)
+      @session.stub(:select_list)
+    end
+
+    it 'executes the correct command' do
+      connection.open
+
+      @session.should_receive(:command).with('SELECT NAMES-FILE TO 0 WITH NAME EQ "JAMES,BILL"')
+      connection.select('NAMES-FILE', 'NAME EQ "JAMES,BILL"')
+    end
+
+    it 'fetchs the correct select list' do
+      connection.open
+      select_list = double
+
+      @session.should_receive(:select_list).with(5).and_return(select_list)
+      connection.select('NAMES-FILE', 'NAME EQ "JAMES,BILL"', 5)
+    end
+
+    it 'returns a SelectList' do
+      connection.open
+      connection.select('NAMES-FILE', 'NAME EQ "JAMES,BILL"').should be_a(Unidata::SelectList)
+    end
+  end
+
   describe '#exists?' do
     before(:each) do
       @file = double('UniFile', :close => nil, :read_field => nil)

data/spec/unidata/model_spec.rb

@@ -41,6 +41,11 @@ describe Unidata::Model do
       obj.age = 25
       obj.age.should == 25
     end
+
+    it 'defines attribute finder for field' do
+      Record.should respond_to(:find_by_name)
+      Record.should respond_to(:find_by_status)
+    end
   end
 
   describe '.to_unidata' do
@@ -164,6 +169,67 @@ describe Unidata::Model do
     end
   end
 
+  describe '.find_by' do
+    before(:each) do
+      @connection = double
+      Unidata.stub(:connection).and_return(@connection)
+
+      records = {}
+
+      records['123'] = Unidata::UniDynArray.new
+      records['123'].replace 1, 'JOHN DOE'
+      records['123'].replace 2, 25
+      records['123'].replace 3, Date.to_unidata(Date.today)
+      records['123'].replace 4, 1, 'AWESOME COMPANY'
+      records['123'].replace 4, 2, 'MANAGER'
+      records['123'].replace 4, 3, 6_000_000
+      records['123'].replace 5, 'INACTIVE'
+
+      records['234'] = Unidata::UniDynArray.new
+      records['234'].replace 1, 'BILL JAMES'
+      records['234'].replace 2, 20
+      records['234'].replace 3, Date.to_unidata(Date.today)
+      records['234'].replace 4, 1, 'AWESOME COMPANY'
+      records['234'].replace 4, 2, 'SALES'
+      records['234'].replace 4, 3, 3_000_000
+      records['234'].replace 5, 'INACTIVE'
+
+      @connection.stub(:read).and_return{|file, id| records[id]}
+
+      select_list = Unidata::SelectList.new StubUniSelectList.new(['123', '234'])
+      @connection.stub(:select).and_return(select_list)
+    end
+
+    it 'should return the models found by attribute' do
+      records = Record.find_by_status('INACTIVE')
+
+      records[0].id.should == '123'
+      records[0].name.should == 'JOHN DOE'
+      records[0].age.should == 25
+      records[0].birth_date.should == Date.today
+      records[0].employer.should == 'AWESOME COMPANY'
+      records[0].job_title.should == 'MANAGER'
+      records[0].salary.should == BigDecimal.new('60_000.00')
+      records[0].status.should == 'INACTIVE'
+
+      records[1].id.should == '234'
+      records[1].name.should == 'BILL JAMES'
+      records[1].age.should == 20
+      records[1].birth_date.should == Date.today
+      records[1].employer.should == 'AWESOME COMPANY'
+      records[1].job_title.should == 'SALES'
+      records[1].salary.should == BigDecimal.new('30_000.00')
+      records[1].status.should == 'INACTIVE'
+    end
+
+    it 'should return an empty array if none are found' do
+      select_list = Unidata::SelectList.new StubUniSelectList.new([])
+      @connection.stub(:select).and_return(select_list)
+
+      Record.find_by_status('ACTIVE').should == []
+    end
+  end
+
   describe '#initialize' do
     it 'captures provied attributes' do
       instance = Record.new(:id => '123', :name => 'John Doe', :status => 'inactive')

data/spec/unidata/select_list_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Unidata::SelectList do
+  def create_list(items, should_cache=false)
+    list = StubUniSelectList.new(items)
+    Unidata::SelectList.new(list, should_cache)
+  end
+
+  let(:list) { create_list ['1', '2', '3'] }
+
+  describe '#each' do
+    it 'should yield each of the items in the select list' do
+      expect {|b| list.each &b }.to yield_successive_args '1', '2', '3'
+    end
+
+    context 'without caching' do
+      it 'should only be able to iterate once' do
+        list.each{|i| i}
+        expect {|b| list.each &b }.not_to yield_control
+      end
+    end
+
+    context 'with caching' do
+      it 'should be able to iterate many times' do
+        list = create_list ['1', '2', '3'], true
+        list.each{|i| i}
+        expect {|b| list.each &b }.to yield_successive_args '1', '2', '3'
+      end
+    end
+  end
+
+  it 'should have the enumerable methods' do
+    list.map{|i| ":#{i}:" }.should == [':1:', ':2:', ':3:']
+  end
+end

metadata

@@ -2,14 +2,14 @@
 name: unidata
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jeremy Israelsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000 Z
+date: 2012-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -77,6 +77,7 @@ files:
 - lib/unidata/extensions/string.rb
 - lib/unidata/field.rb
 - lib/unidata/model.rb
+- lib/unidata/select_list.rb
 - lib/unidata/version.rb
 - LICENSE
 - README.md
@@ -84,6 +85,7 @@ files:
 - spec/unidata/connection_spec.rb
 - spec/unidata/field_spec.rb
 - spec/unidata/model_spec.rb
+- spec/unidata/select_list_spec.rb
 - spec/unidata_spec.rb
 homepage: http://github.com/jisraelsen/unidata
 licenses: []
@@ -114,5 +116,6 @@ test_files:
 - spec/unidata/connection_spec.rb
 - spec/unidata/field_spec.rb
 - spec/unidata/model_spec.rb
+- spec/unidata/select_list_spec.rb
 - spec/unidata_spec.rb
 ...