amee-data-abstraction 1.3.1 → 2.0.0

data/.rvmrc

@@ -1 +1 @@
-rvm 1.8.7@amee-data-abstraction-rails2
+rvm 1.8.7@amee-data-abstraction

data/CHANGELOG.txt

@@ -1,7 +1,4 @@
 = Changelog
 
-== 1.3.0
-  * Reconfigure storage and API for Calculation Sets
-
 == 1.0.0
   * Initial public release

data/Gemfile

@@ -1,16 +1,14 @@
 source "http://rubygems.org"
 
-gem "amee", "~> 3.1"
+gem "amee", "~> 4.0"
 gem 'uuidtools', '2.1.2'
-gem 'quantify', '1.2.2'
+gem 'quantify', '~> 2.0.0'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
-  gem 'rspec', '1.3.0'
-  gem 'rcov'
-  gem 'rspec_spinner', '1.1.3'
+  gem 'rspec', '2.6.0'
   gem 'flexmock', '> 0.8.6'
+  gem 'rcov'
+  gem 'rdoc'
 end

data/Gemfile.lock

@@ -1,12 +1,13 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (2.3.12)
-    amee (3.1.2)
-      activesupport (~> 2.3.5)
+    activesupport (3.0.10)
+    amee (4.0.0)
+      activesupport (~> 3.0.10)
       json
       log4r
       nokogiri (~> 1.4.3.1)
+    diff-lcs (1.1.3)
     flexmock (0.9.0)
     git (1.2.5)
     i18n (0.6.0)
@@ -14,30 +15,35 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.1)
+    json (1.5.4)
     log4r (1.1.9)
     nokogiri (1.4.3.1)
-    quantify (1.2.2)
-      activesupport
+    quantify (2.0.0)
+      activesupport (~> 3.0.10)
       i18n
     rake (0.9.2)
     rcov (0.9.10)
-    rspec (1.3.0)
-    rspec_spinner (1.1.3)
-      rtui
-    rtui (0.2.2)
+    rdoc (3.9.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
     uuidtools (2.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  amee (~> 3.1)
+  amee (~> 4.0)
   bundler (~> 1.0.0)
   flexmock (> 0.8.6)
   jeweler (~> 1.6.4)
-  quantify (= 1.2.2)
+  quantify (~> 2.0.0)
   rcov
-  rspec (= 1.3.0)
-  rspec_spinner (= 1.1.3)
+  rdoc
+  rspec (= 2.6.0)
   uuidtools (= 2.1.2)

data/README.txt

@@ -25,9 +25,9 @@ Documentation: http://rubydoc.info/gems/amee-data-abstraction
  All gem requirements should be installed as part of the rubygems installation process 
  above, but are listed here for completeness.
 
- * amee ~> 3.1
+ * amee ~> 3.0
  * uuidtools = 2.1.2
- * quantify = 1.2.2
+ * quantify = 1.1.0
  
 == USAGE
 
@@ -117,10 +117,16 @@ Submit to AMEE for calculation
 
 Typical practice is initialize the calculation prototypes required for an
 application via a configuration file which creates the required calculation
-templates within an instance of CalculationSet. Such a configuration file can
-be structured the follow DSL:
+templates within an instance of CalculationSet. If the calculation set is assigned
+to a global variable or constant, the set of prototypes is available for
+initializing new calculations and templating view structures (e.g. tables, forms)
+from anywhere in the application.
 
-  # e.g. /config/calculations/my_emissions_calculations.rb
+Adding a configuration to /config or /config/initializers may be appropriate
+
+  # e.g. /config/initializers/calculations.rb
+
+   Calculations = AMEE::DataAbstraction::CalculationSet {
 
     calculation {
       label :electricity
@@ -142,36 +148,17 @@ be structured the follow DSL:
       path "/some/fuel/associated/path/in/amee"
       terms_from_amee
     }
-
-The default location for such files within Rails applications is under
-/config/calculations. If such an approach is taken, the configuration can be
-read and a calculation set generated by using the filename, thus:
-
-  CalculationSet.find('my_emissions_calculations')
-
-                          #=> <AMEE::DataAbstraction::CalculationSet ... >
-
-Otherwise, the path to the configuration file can be provided:
-
-  CalculationSet.find('some/directory/my_emissions_calculations')
-
-                          #=> <AMEE::DataAbstraction::CalculationSet ... >
-
-The calculation set is accessible as follow using the same argument as used
-by the Find method (filename if conventional Rails location, path otherwise):
-
-  CalculationSet.sets['my_emissions_calculations']
+  }
 
                           #=> <AMEE::DataAbstraction::CalculationSet ... >
 
-And a new calcualtion can be initialized by providing the prototype calculation
-label:
+From this global calculation set, initialize a new calculation
 
-  my_fuel_calculation = CalculationSet.sets['my_emissions_calcualtions'][:fuel].begin_calculation
+  my_fuel_calculation = Calculations[:fuel].begin_calculation
 
                           #=> <AMEE::DataAbstraction::OngoingCalculation ... >
 
-  a_different_transport_calculation = CalculationSet.sets['my_emissions_calcualtions'][:transport].begin_calculation
+  a_different_transport_calculation = Calculations[:transport].begin_calculation
 
                           #=> <AMEE::DataAbstraction::OngoingCalculation ... >
 

data/Rakefile

@@ -13,16 +13,14 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-require 'spec'
-require 'spec/rake/spectask'
+require 'rspec'
+require 'rspec/core/rake_task'
 
 task :default => [:spec]
 
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,/*ruby*,/*gems*']
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
 end
 
 require 'jeweler'
@@ -74,14 +72,17 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'rcov/rcovtask'
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "amee-data-abstraction #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'rdoc/task'
+RDoc::Task.new do |rd|
+  rd.title = "AMEE Data Abstraction"
+  rd.rdoc_dir = 'doc'
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
 end

data/VERSION

@@ -1 +1 @@
-1.3.1
+2.0.0

data/amee-data-abstraction.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee-data-abstraction}
-  s.version = "1.3.0"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Hetherington", "Andrew Berkeley", "James Smith", "George Palmer"]
-  s.date = %q{2011-10-18}
+  s.date = %q{2011-09-28}
   s.description = %q{Part of the AMEEappkit this gem provides a data abstraction layer, decreasing the amount and detail of development required}
   s.email = %q{help@amee.com}
   s.extra_rdoc_files = [
@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
     "amee-data-abstraction.gemspec",
     "examples/_calculator_form.erb",
     "examples/calculation_controller.rb",
-    "init.rb",
     "lib/amee-data-abstraction.rb",
     "lib/amee-data-abstraction/calculation.rb",
     "lib/amee-data-abstraction/calculation_set.rb",
@@ -48,7 +47,6 @@ Gem::Specification.new do |s|
     "lib/core-extensions/hash.rb",
     "lib/core-extensions/ordered_hash.rb",
     "lib/core-extensions/proc.rb",
-    "rails/init.rb",
     "spec/amee-data-abstraction/calculation_set_spec.rb",
     "spec/amee-data-abstraction/calculation_spec.rb",
     "spec/amee-data-abstraction/drill_spec.rb",
@@ -64,53 +62,52 @@ Gem::Specification.new do |s|
     "spec/core-extensions/hash_spec.rb",
     "spec/core-extensions/ordered_hash_spec.rb",
     "spec/core-extensions/proc_spec.rb",
-    "spec/fixtures/config/calculations/electricity.rb",
-    "spec/fixtures/config/calculations/electricity_and_transport.rb",
-    "spec/fixtures/config/calculations/transport.rb",
-    "spec/fixtures/config/electricity.rb",
+    "spec/fixtures/electricity.rb",
+    "spec/fixtures/electricity_and_transport.rb",
+    "spec/fixtures/transport.rb",
     "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/AMEE/amee-data-abstraction}
   s.licenses = ["BSD 3-Clause"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.3}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{Calculation and form building tool hiding details of AMEEconnect}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<amee>, ["~> 3.1"])
+      s.add_runtime_dependency(%q<amee>, ["~> 4.0"])
       s.add_runtime_dependency(%q<uuidtools>, ["= 2.1.2"])
-      s.add_runtime_dependency(%q<quantify>, ["= 1.2.2"])
+      s.add_runtime_dependency(%q<quantify>, ["~> 2.0.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_development_dependency(%q<rspec>, ["= 2.6.0"])
       s.add_development_dependency(%q<flexmock>, ["> 0.8.6"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
     else
-      s.add_dependency(%q<amee>, ["~> 3.1"])
+      s.add_dependency(%q<amee>, ["~> 4.0"])
       s.add_dependency(%q<uuidtools>, ["= 2.1.2"])
-      s.add_dependency(%q<quantify>, ["= 1.2.2"])
+      s.add_dependency(%q<quantify>, ["~> 2.0.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-      s.add_dependency(%q<rspec>, ["= 1.3.0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_dependency(%q<rspec>, ["= 2.6.0"])
       s.add_dependency(%q<flexmock>, ["> 0.8.6"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
     end
   else
-    s.add_dependency(%q<amee>, ["~> 3.1"])
+    s.add_dependency(%q<amee>, ["~> 4.0"])
     s.add_dependency(%q<uuidtools>, ["= 2.1.2"])
-    s.add_dependency(%q<quantify>, ["= 1.2.2"])
+    s.add_dependency(%q<quantify>, ["~> 2.0.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
-    s.add_dependency(%q<rspec>, ["= 1.3.0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+    s.add_dependency(%q<rspec>, ["= 2.6.0"])
     s.add_dependency(%q<flexmock>, ["> 0.8.6"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
   end
 end
 

data/lib/amee-data-abstraction.rb

@@ -27,4 +27,10 @@ require File.dirname(__FILE__) + '/amee-data-abstraction/metadatum'
 module AMEE::DataAbstraction
   # Connection to AMEE server.
   mattr_accessor :connection
+  
+  if defined?(Rails)
+    def self.connection
+      AMEE::Rails.connection
+    end
+  end
 end

data/lib/amee-data-abstraction/calculation.rb

@@ -132,7 +132,7 @@ module AMEE
       end
 
       def explorer_url
-         Rails.logger.info "#explorer_url method deprecated. Use #discover_url" if defined?(Rails) && Rails.logger.present?
+         ::Rails.logger.info "#explorer_url method deprecated. Use #discover_url" if defined? Rails
          discover_url
       end
        

data/lib/amee-data-abstraction/calculation_set.rb

@@ -36,95 +36,22 @@ module AMEE
     #
     class CalculationSet
 
-      # Class variable holding all instantiated calculation sets keyed on the set
-      # name.
+      # Initialize a <i>CalculationSet</i> with a "DSL" block, i.e. a block to be
+      # evaluated in the context of the instantiated CalculationSet
       #
-      @@sets = {}
-
-      # Convenience method for accessing the @@sets class variable
-      def self.sets
-        @@sets
-      end
-
-      # Retrieve a calculation set on the basis of a configuration file name or
-      # relatiev/absolute file path. If configuration files are location within
-      # the default Rails location under '/config/calculations' then the path and
-      # the .rb extenstion can be omitted from the name.
-      #
-      def self.find(name)
-        @@sets[name.to_sym] or load_set(name)
-      end
-
-      # Regenerate a configuration lock file assocaited with the master
-      # configuration file <tt>name</tt>. Optionally set a custom path for the
-      # lock file as <tt>output_path</tt>, otherwise the lock file path and
-      # filename will be based upon the master file with the extension .lock.rb.
-      #
-      def self.regenerate_lock_file(name,output_path=nil)
-        set = CalculationSet.find(name)
-        set.generate_lock_file(output_path)
-      end
-
-      # Find a specific prototype calculation instance without specifying the set
-      # to which it belongs.
-      #
-      def self.find_prototype_calculation(label)
-        @@sets.each_pair do |name,set|
-          set = find(name)
-          return set[label] if set[label]
-        end
-        return nil
-      end
-
-      protected
-
-      # Load a calculation set based on a filename or full path.
-      def self.load_set(name)
-        CalculationSet.new(name,:file => name) do
-          instance_eval(File.open(self.config_path).read)
-        end
-      end
-
-      DEFFAULT_RAILS_CONFIG_DIR = "config/calculations"
-
-      # Find the config file assocaited with <tt>name</tt>. The method first checks
-      # the default Rails configuration location (config/calculations) then the
-      # file path described by <tt>name</tt> relative to the Rails root and by
-      # absolute path.
-      def self.find_config_file(name)
-        default_config_dir = defined?(::Rails) ? "#{::Rails.root}/#{DEFFAULT_RAILS_CONFIG_DIR}" : nil
-        if defined?(::Rails) && File.exists?("#{default_config_dir}/#{name.to_s}.rb")
-          "#{default_config_dir}/#{name.to_s}.rb"
-        elsif defined?(::Rails) && File.exists?("#{default_config_dir}/#{name.to_s}")
-          "#{default_config_dir}/#{name.to_s}"
-        elsif defined?(::Rails) && File.exists?("#{::Rails.root}/#{name}")
-          "#{::Rails.root}/#{name}"
-        elsif File.exists?(name)
-          name
-        else
-          raise ArgumentError, "The config file '#{name}' could not be located"
-        end
-      end
-
-      public
-      
-      attr_accessor :calculations, :name, :file
-
-      # Initialise a new Calculation set. Specify the name of the calculation set 
-      # as the first argument. This name is used as the set key within the class
-      # variable @@sets hash.
-      #
-      def initialize(name,options={},&block)
-        raise ArgumentError, "Calculation set must have a name" unless name
-        @name = name
-        @file = CalculationSet.find_config_file(options[:file]) if options[:file]
-        @calculations = ActiveSupport::OrderedHash.new
+      def initialize(options={},&block)
+        @calculations=ActiveSupport::OrderedHash.new
         @all_blocks=[]
         @all_options={}
         instance_eval(&block) if block
-        @@sets[@name.to_sym] = self
       end
 
+      # Access the @calculations instance variable ordered hash. Keys are labels
+      # assocaited with each prototype calculation; values are the instantiated
+      # <i>PrototypeCalculation</i> objects
+      #
+      attr_accessor :calculations
+
       # Shorthand method for returning the prototype calculation which is represented
       # by a label matching <tt>sym</tt>
       #
@@ -167,77 +94,8 @@ module AMEE
             instance_exec(usage,&dsl_block)
           }
         end
-      end
 
-      # Returns the path to the configuration file for <tt>self</tt>. If a .lock
-      # file exists, this takes precedence, otherwise the master config file
-      # described by the <tt>#file</tt> attribute is returned.
-      #
-      def config_path
-        lock_file_exists? ? lock_file_path : @file
       end
-
-      # Returns the path to the configuration lock file
-      def lock_file_path
-        @file.gsub(".rb",".lock.rb") rescue nil
-      end
-
-      # Returns <tt>true</tt> if a configuration lock file exists. Otherwise,
-      # returns <tt>false</tt>.
-      #
-      def lock_file_exists?
-        File.exists?(lock_file_path)
-      end
-
-      # Generates a lock file for the calcuation set configuration. If no argument
-      # is provided the, the lock file is generated using the filename and path
-      # described by the <tt>#lock_file_path</tt> method. If a custom output
-      # location is required, this can be provided optionally as an argument.
-      #
-      def generate_lock_file(output_path=nil)
-        file = output_path || lock_file_path or raise ArgumentError,
-          "No path for lock file known. Either set path for the master config file using the #file accessor method or provide as an argument"
-        string = ""
-        @calculations.values.each do |prototype_calculation|
-          string += "calculation {\n\n"
-          string += "  name \"#{prototype_calculation.name}\"\n"
-          string += "  label :#{prototype_calculation.label}\n"
-          string += "  path \"#{prototype_calculation.path}\"\n\n"
-          prototype_calculation.terms.each do |term|
-            string += "  #{term.class.to_s.split("::").last.downcase} {\n"
-            string += "    name \"#{term.name}\"\n" unless term.name.blank?
-            string += "    label :#{term.label}\n" unless term.label.blank?
-            string += "    path \"#{term.path}\"\n" unless term.path.blank?
-            string += "    value \"#{term.value}\"\n" unless term.value.blank?
-
-            if term.is_a?(AMEE::DataAbstraction::Input)
-              string += "    fixed \"#{term.value}\"\n" if term.fixed? && !term.value.blank?
-              if term.is_a?(AMEE::DataAbstraction::Drill)
-                string += "    choices \"#{term.choices.join('","')}\"\n" if term.instance_variable_defined?("@choices")  && !term.choices.blank?
-              elsif term.is_a?(AMEE::DataAbstraction::Profile)
-                string += "    choices [\"#{term.choices.join('","')}\"]\n" if term.instance_variable_defined?("@choices")  && !term.choices.blank?
-              end
-              string += "    optional!\n" if term.optional?
-            end
-
-            string += "    default_unit :#{term.default_unit.label}\n" unless term.default_unit.blank?
-            string += "    default_per_unit :#{term.default_per_unit.label}\n" unless term.default_per_unit.blank?
-            string += "    alternative_units :#{term.alternative_units.map(&:label).join(', :')}\n" unless term.alternative_units.blank?
-            string += "    alternative_per_units :#{term.alternative_per_units.map(&:label).join(', :')}\n" unless term.alternative_per_units.blank?
-            string += "    unit :#{term.unit.label}\n" unless term.unit.blank?
-            string += "    per_unit :#{term.per_unit.label}\n" unless term.per_unit.blank?
-            string += "    type :#{term.type}\n" unless term.type.blank?
-            string += "    interface :#{term.interface}\n" unless term.interface.blank?
-            string += "    note \"#{term.note}\"\n" unless term.note.blank?
-            string += "    disable!\n" if !term.is_a?(AMEE::DataAbstraction::Drill) && term.disabled?
-            string += "    hide!\n" if term.hidden?
-            string += "  }\n\n"
-          end
-          string += "}\n\n"
-        end
-        File.open(file,'w') { |f| f.write string }
-      end
-
     end
   end
 end