lardawge-rfm 1.4.0 → 1.4.1

data/lib/rfm.rb

@@ -1,241 +1,19 @@
-# RFM provides easy access to FileMaker Pro data. With it, Ruby scripts can
-# perform finds, read records and fields, update data, and perform scripts using
-# a simple ruby-like syntax.
-#
-# Author::    Geoff Coffey  (mailto:gwcoffey@gmail.com)
-# Copyright:: Copyright (c) 2007 Six Fried Rice, LLC and Mufaddal Khumri
-# License::   See MIT-LICENSE for details
-#
-# RFM uses the FileMaker XML API, so it requires:
-# - FileMaker Server 9.0 or later
-# - or FileMaker Server Advanced 7.0 or later
-#
-# This documentation serves as a reference to the classes in the API. For more complete
-# usage documentation, see the RFM home page at http://sixfriedrice.com/wp/products/rfm/
-#
-# = Quick Start
-#
-# Rfm is a Gem. As such, any ruby file that uses it, needs to have these two lines on top:
-#
-#   require "rubygems"
-#   require "rfm"
-#
-# (If you don't have Rfm installed, use the +gem install rfm+ command to get it.)
-#
-# === Get a Server
-#
-# Everything in Rfm starts with the Server object. You create a Server object like this:
-#
-#   myServer = Rfm::Server.new(
-#     :host => "yourhost",
-#     :account_name => "someone",
-#     :pasword => "secret"
-#   )
-#
-# The Server object supports many other options, which you'll find explained in its
-# documentation.
-#
-# Note: The account name and password are optional. You can instead provide them on 
-# a per-database basis (using Database::account_name and Database::password). But 
-# it is convenient to do it here because you often have one set of credentials
-# across all databases. Also, you must provide an account_name and password if you
-# want to ask the server for a list of available databases.
-#
-# === Get a Database
-#
-# Once you have a Server object, you can use it to get a Database. For example, if your
-# database is called "Customers", you get it like this:
-#
-#   myDatabase = myServer["Customers"]
-#
-# If you need to supply account and password info specifically for this database
-# (rather than doing it at the Server level), do this:
-#
-#   myDatabase.account_name = "someone"
-#   myDatabase.password = "secret"
-#
-# *IMPORTANT NOTE:* The account name you use to access FileMaker must have the
-# +fmxml+ extended privilege. In other words, edit its privilege set and turn on
-# "Access via XML Web Publishing (fmxml)" in the Extended Privileges section
-# at the bottom-left of the Edit Privilege Set window. If you don't do this, 
-# Rfm will report that it can't log in.
-#
-# === Get a Layout
-#
-# Every action you send to FileMaker always goes through a layout. This is how Rfm knows
-# which table you want to work with, and which fields on that table you care about. This 
-# should feel pretty familiar now:
-#
-#   myLayout = myDatabase["Details"]
-#
-# You might use layouts you already have, or make new layout just for Rfm. Just remember that
-# if you delete a layout, or remove a field from a layout that your Rfm code uses, the 
-# code will stop working.
-#
-# === Putting it Together
-#
-# Usually you don't care much about the intermediate Database object (it's a gateway object,
-# if you will). So it is often easiest to combine all the above steps like this:
-#
-#   myLayout = myServer["Customers"]["Details"]
-#
-# === Performing Actions
-#
-# The Layout object can do a lot of things (see its documentation for a full list). But
-# in general, it involves records. For instance, you can find records:
-#
-#   result = myLayout.find({"First Name" => "Bill"})
-#
-# That code finds everybody whose first name in Bill. All the Layout methods return an
-# ResultSet object. It contains the records, as well as metadata about the fields and 
-# portals on the layout. Usually you'll only concern yourself with the records (and you
-# can read about the others in the ResultSet documentation). 
-#
-# ResultSet is a subclass of Array, Ruby's built in array type. So you can treate it just
-# like any other array:
-#
-#   first_record = result[0]
-#   a_few_records = result[3,7]
-#   record_count = result.size
-#
-# But usually you'll want to loop through them all. Because this is an array, you can use
-# code that is familiar to any Ruby whiz:
-#
-#   result.each { |record|
-#     # do something with record here
-#   }
-# 
-# === Working with Records
-#
-# The records in a ResultSet are actually Record objects. They hold the actual data from
-# FileMaker. Record subclasses Hash, another built in Ruby type, so you can use them like
-# this:
-#
-#   full_name = record["First Name"] + ' ' + record["Last Name"]
-#   info.merge(record)
-#   record.each_value { |value| puts value }
-#   if record.value?("Bill") then puts "Bill is in there somewhere"
-# 
-# The field name serves as the hash key, so these examples get fields called First Name and
-# Last Name. (Note: Unlike a typical Ruby hash, Record objects are not case sensitive. You
-# can say +record["first name"]+ or +record["FIRST NAME"]+ and it will still work.)
-#
-# A record object has the power to save changes to itself back to the database. For example:
-#
-#   records.each { |record| 
-#     record["First Name"] = record["First Name"].upcase
-#     record.save
-#   }
-#
-# That concise code converts the First Name field to all uppercase in every record in the
-# ResultSet. Note that each time you call Record::save, if the record has been modified, 
-# Rfm has to send an action to FileMaker. A loop like the one above will be quite slow
-# across many records. There is not fast way to update lots of records at once right now,
-# although you might be able to accomplish it with a FileMaker script by passing a 
-# parameter).
-#
-# === Editing and Deleting Records
-#
-# Any time you edit or delete a record, you *must* provide the record's internal record
-# if. This is not the value in any field. Rather, it is the ID FileMaker assigns to the
-# record internally. So an edit or delete is almost always a two-step process:
-#
-#   record = myLayout.find({"Customer ID" => "1234"})[0]
-#   myLayout.edit(record.record_id, {"First Name" => "Steve"})
-#
-# The code above first finds a Customer record. It then uses the Record::record_id method
-# to discover that record's internal id. That id is passed to the Layout::edit method.
-# The edit method also accepts a hash of record changes. In this case, we're changing
-# the value in the First Name field to "Steve".
-#
-# Also, note the [0] on the end of the first line. A find _always_ returns a ResultSet.
-# If there's only one record, it is still in an array. This array just happens to have only
-# one element. The [0] pulls out that single record.
-#
-# To delete a record, you would do this instead:
-#
-#   record = myLayout.find({"Customer ID" => "1234"})[0]
-#   myLayout.delete(record.record_id)
-#
-# Finally, the Layout::find method can also find a record using its internal id:
-#
-#   record = myLayout.find(some_id)
-#
-# If the parameter you pass to Layout::find is not a hash, it is converted to a string
-# and assumed to be a record id.
-#
-# === Performing Scripts
-#
-# Rfm can run a script in conjunction with any other action. For example, you might want
-# to find a set of records, then run a script on them all. Or you may want to run a script
-# when you delete a record. Here's how:
-#
-#   myLayout.find({"First Name" => "Bill"}, {:post_script => "Process Sales"})
-#
-# This code finds every record with "Bill" in the First Name field, then  runs the script
-# called "Process Sales." You can control when the script actually runs, as explained in
-# the documentation for Common Options for the Layout class.
-#
-# You can also pass a parameter to the script when it runs. Here's the deal:
-#
-#   myLayout.find(
-#     {"First Name" => "Bill"},
-#     {:post_script => ["Process Sales", "all"]}
-#   )
-#
-# This time, the text value "all" is passed to the script as a script parameter.
-#
-# =Notes on Rfm with Ruby on Rails
-#
-# Rfm is a great fit for Rails. But it isn't ActiveRecord, so you need to do things
-# a little differently.
-#
-# === Configuration
-#
-# To avoid having to reconfigure your Server object in every Rails action, you 
-# might add a configuration hash to the environment.rb. It can include all the
-# options you need to connecto to your server:
-#
-#   RFM_CONFIG = {
-#     :host => "yourhost",
-#     :account_name => "someone",
-#     :password => "secret",
-#     :db => "Customers"
-#   }
-#
-# Then you can get a server concisely:
-#
-#   myServer = Server.net(RFM_CONFIG)
-#   myServer[RFM_CONFIG[:db]]["My Layout"]...
-#
-# You might even want to add code to your application.rb to centralize access
-# to your various layouts.
-#
-# === Disable ActiveRecord
-#
-# If you're not using any SQL database in your Rails app, you'll quickly discover
-# that Rails insists on a SQL database configuration anyway. This is easy to fix.
-# Just turn off ActiveRecord. In the environment.rb, find the line that starts with
-# +config.frameworks+. This is where you can disable the parts of Rails you're not 
-# using. Uncomment the line and make it look like this:
-#
-#     config.frameworks -= [ :active_record ]
-# 
-# Now Rails will no longer insist on a SQL database.
 path = File.expand_path(File.dirname(__FILE__))
 $:.unshift(path) unless $:.include?(path)
 
+require path + '/rfm/utilities/case_insensitive_hash'
+require path + '/rfm/utilities/factory'
+
 module Rfm
   
-  autoload :Error, "rfm/error"
-  autoload :Factory, "rfm/factory"
-  autoload :Result, "rfm/result"
-  autoload :Utility, "rfm/utility"
-  
-  autoload :Database, 'rfm/commands/database'
-  autoload :FieldControl, 'rfm/commands/field_control'
-  autoload :Layout, 'rfm/commands/layout'
-  autoload :Script, 'rfm/commands/script'
-  autoload :Server, 'rfm/commands/server'
+  class CommunicationError  < StandardError; end
+  class ParameterError      < StandardError; end
+  class AuthenticationError < StandardError; end
+
+  autoload :Error,     'rfm/error'
+  autoload :Server,    'rfm/server'
+  autoload :Database,  'rfm/database'
+  autoload :Layout,    'rfm/layout'
+  autoload :Resultset, 'rfm/resultset'
   
 end

data/spec/rfm/error_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Rfm
+  err_module = Error
+  describe err_module do
+    describe ".lookup" do
+      
+      it "should return a default system error if input code is 0" do
+        error = err_module.getError(0)
+        error.message.should eql('SystemError occurred: (FileMaker Error #0)')
+        error.code.should eql(0)
+      end
+      
+      it "should return a default system error if input code is 22" do
+        error = err_module.getError(20)
+        error.message.should eql('SystemError occurred: (FileMaker Error #20)')
+        error.code.should eql(20)
+      end
+      
+      it "should return a custom message as second argument" do
+        error = err_module.getError(104, 'Custom Message Here.')
+        error.message.should match(/Custom Message Here/)
+      end
+    
+      it "should return a script missing error" do
+        error = err_module.getError(104)
+        error.message.should eql('ScriptMissingError occurred: (FileMaker Error #104)')
+        error.code.should eql(104)
+      end  
+      
+      it "should return a range validation error" do
+        error = err_module.getError(503)
+        error.message.should eql('RangeValidationError occurred: (FileMaker Error #503)')
+        error.code.should eql(503)
+      end  
+      
+      it "should return unknown error if code not found" do
+        error = err_module.getError(-1)
+        error.message.should eql('UnknownError occurred: (FileMaker Error #-1)')
+        error.code.should eql(-1)
+        error.class.should eql(Error::UnknownError)
+      end
+      
+    end
+    
+    describe ".find_by_code" do
+      it "should return a constant representing the error class" do
+        constant = err_module.find_by_code(503)
+        constant.should eql(err_module::RangeValidationError)
+      end
+    end
+    
+    describe ".build_message" do
+      before(:each) do
+        @message = err_module.build_message(503, 'This is a custom message')
+      end
+      
+      it "should return a string with the code and message included" do
+        @message.should match(/This is a custom message/)
+        @message.should match(/503/)
+      end
+      
+      it "should look like" do
+        @message.should eql('503 occurred: (FileMaker Error #This is a custom message)')
+      end
+    end
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rfm'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lardawge-rfm
 version: !ruby/object:Gem::Version 
-  version: 1.4.0
+  hash: 5
+  prerelease: false
+  segments: 
+  - 1
+  - 4
+  - 1
+  version: 1.4.1
 platform: ruby
 authors: 
 - Geoff Coffey
@@ -12,20 +18,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-19 00:00:00 -05:00
+date: 2010-06-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
-description: Rfm brings your FileMaker data to Ruby with elegance and speed. Now your Ruby scripts and Rails applications can talk directly to your FileMaker server with a syntax that just feels right.
+  type: :runtime
+  version_requirements: *id001
+description: Rfm brings your FileMaker data to Ruby. Now your Ruby scripts and Rails applications can talk directly to your FileMaker server.
 email: http://groups.google.com/group/rfmcommunity
 executables: []
 
@@ -36,17 +46,20 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/rfm.rb
-- lib/rfm/commands/database.rb
-- lib/rfm/commands/field_control.rb
-- lib/rfm/commands/layout.rb
-- lib/rfm/commands/script.rb
-- lib/rfm/commands/server.rb
+- lib/rfm/database.rb
 - lib/rfm/error.rb
-- lib/rfm/factory.rb
-- lib/rfm/result.rb
-- lib/rfm/utility.rb
+- lib/rfm/layout.rb
+- lib/rfm/metadata/field.rb
+- lib/rfm/metadata/script.rb
+- lib/rfm/record.rb
+- lib/rfm/resultset.rb
+- lib/rfm/server.rb
+- lib/rfm/utilities/case_insensitive_hash.rb
+- lib/rfm/utilities/factory.rb
 - LICENSE
 - README.rdoc
+- spec/rfm/error_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://sixfriedrice.com/wp/products/rfm/
 licenses: []
@@ -59,23 +72,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: FileMaker to Ruby adapter
+summary: Ruby to Filemaker adapter
 test_files: 
-- test/errors_test.rb
+- spec/rfm/error_spec.rb
+- spec/spec_helper.rb

data/lib/rfm/commands/field_control.rb

@@ -1,50 +0,0 @@
-module Rfm
-  # The FieldControl object represents a field on a FileMaker layout. You can find out what field
-  # style the field uses, and the value list attached to it.
-  #
-  # =Attributes
-  #
-  # * *name* is the name of the field
-  #
-  # * *style* is any one of:
-  # * * :edit_box - a normal editable field
-  # * * :scrollable - an editable field with scroll bar
-  # * * :popup_menu - a pop-up menu
-  # * * :checkbox_set - a set of checkboxes
-  # * * :radio_button_set - a set of radio buttons
-  # * * :popup_list - a pop-up list
-  # * * :calendar - a pop-up calendar
-  #
-  # * *value_list_name* is the name of the attached value list, if any
-  # 
-  # * *value_list* is an array of strings representing the value list items, or nil
-  #   if this field has no attached value list
-  class FieldControl
-    def initialize(name, style, value_list_name, value_list)
-      @name = name
-      case style
-      when "EDITTEXT"
-        @style = :edit_box
-      when "POPUPMENU"
-        @style = :popup_menu
-      when "CHECKBOX"
-        @style = :checkbox_set
-      when "RADIOBUTTONS"
-        @style = :radio_button_set
-      when "POPUPLIST"
-        @style = :popup_list
-      when "CALENDAR"
-        @style = :calendar
-      when "SCROLLTEXT"
-        @style = :scrollable
-      else
-        nil
-      end
-      @value_list_name = value_list_name
-      @value_list = value_list
-    end
-    
-    attr_reader :name, :style, :value_list_name, :value_list
-  
-  end
-end

data/lib/rfm/commands/script.rb

@@ -1,18 +0,0 @@
-module Rfm
-  # The Script object represents a FileMaker script. At this point, the Script object exists only so
-  # you can enumrate all scripts in a Database (which is a rare need):
-  # 
-  #   myDatabase.script.each {|script|
-  #     puts script.name
-  #   }
-  #
-  # If you want to _run_ a script, see the Layout object instead.
-  class Script
-    def initialize(name, db)
-      @name = name
-      @db = db
-    end
-    
-    attr_reader :name
-  end
-end