lca 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc53882ad2b8c5c34b869be0546546973dd829b25aa39f354e9be9da63a44fae
-  data.tar.gz: 57c65eeadf05e7e6f160ea1c2ca3db8a025614578ecb6242d9f1404002651766
+  metadata.gz: 62afb1561f978b69743ea334e439cc449375f0b4bc1cad29601b174a5d231a41
+  data.tar.gz: 1f18a6226d1fee18f3e2d226616c34dd3cae9ba99389ef9ffb17cf828c586e34
 SHA512:
-  metadata.gz: 2a1542ddf863b9461fb3ceb67e45f59599608c40e98994203918b7aeb4fb87ef2e4b1f73bd7fa3a837a0cd9cbd691cf72648505f38f156c64b84b6ee097d0dd6
-  data.tar.gz: e7989620c9b0a81249e741b41bcbe8fd1854b24650d66e4963ce940ab593d8ea2340403f06f467d8e280cea3dfed99d1c5067407771557403bf2d049cf792b0c
+  metadata.gz: e190b6449f86a075d6582276747f6f17b1d617cf404f1db04ef7600f7ac9a84490d60535901a9b1e3fc212fb855b381fb80f78d583db391a159b27c75b63e9a3
+  data.tar.gz: b2fc67ead55300e549192c8f1b37e2971e11bc4da9ed08956ea46a601fc6aba1596a56106822f1b085e2c82d94560975bcc301ef8df3946121a331ddcd925a7f

data/README.md

@@ -4,7 +4,7 @@
 
 Storing, processing and working with life-cycle assessment data has always been challenging. A multitude of data models and implementations exist already but every one of them makes huge compromises or lacks functionality. 
 
-This gem implements a denormalized database model for life-cycle assessment data as well as several innovative query interfaces. 
+This gem implements a denormalized database model for life-cycle assessment data as well as several vectors for convenient querying. 
 
 ## Installation
 
@@ -42,42 +42,42 @@ Include the LCA concern into one of your models which will own lifecycle trees (
 This will extend your model and enable the following functionality:
 
 ```ruby
-    # query with ActiveRecord syntax
-    User.last.lca_cycles
-    User.find_by(name: "Acme").lca_cycles.impacts.select("impact_unit, sum(impact_amount) as total_impact").group(:impact_unit)
-    User.last.lca_cycles.where(...)
-    User.last.lca_cycles.where(...).group(...)
-    User.last.lca_cycles.where(...).limit(...).offset(...)
+# query with ActiveRecord syntax
+User.last.lca_cycles
+User.find_by(name: "Acme").lca_cycles.impacts.select("impact_unit, sum(impact_amount) as total_impact").group(:impact_unit)
+User.last.lca_cycles.where(...)
+User.last.lca_cycles.where(...).group(...)
+User.last.lca_cycles.where(...).limit(...).offset(...)
     
-    # AR query with ltree syntax
-    User.last.lca_cycles.disabled.match_path("*.CustomProcess.*")
-    User.last.lca_cycles.match_path("*{5,10}.CustomProcess.*.Ecosphere.*")
-    User.last.lca_cycles.active.match_path("*.WhateverProcess.*.Ecosphere.*.CO2Emission.*").where( impact_amount: [100..150]).sum(:impact_amount)
-
-    Lca::Cycle.match_path("Top.Electric Vehicle.*").impacts.match_path("*.CO2*").where( impact_amount: [ 1000..10000 ]).average(:impact_amount)
-    Lca::Cycle::Product.where(name: "Electric Vehicle Battery").impacts.match_path("*.Cobalt.*").sum(:impact_amount)
-    Lca::Process.where(owner: User.last).match_path("*{10,20}.*Assembly, automated.*")
-    Lca::Impact.match_path("*.Transport by truck.*")
-    Lca::Exchange.match_path("*.Oil.*.Ecosphere.*").impacts.sum(:impact_amount)
-    Lca::Product.match_path("*.ElectricVehicle.*").processes.match_path("*.Processing.*").where(location: "EU").impacts.match_path("*.Lithium.*").where(location: ["CN", "Africa"]).sum(:impact_amount)
+# AR query with ltree syntax
+User.last.lca_cycles.disabled.match_path("*.CustomProcess.*")
+User.last.lca_cycles.match_path("*{5,10}.CustomProcess.*.Ecosphere.*")
+User.last.lca_cycles.active.match_path("*.WhateverProcess.*.Ecosphere.*.CO2Emission.*").where( impact_amount: [100..150]).sum(:impact_amount)
+
+Lca::Cycle.match_path("Top.Electric Vehicle.*").impacts.match_path("*.CO2*").where( impact_amount: [ 1000..10000 ]).average(:impact_amount)
+Lca::Cycle::Product.where(name: "Electric Vehicle Battery").impacts.match_path("*.Cobalt.*").sum(:impact_amount)
+Lca::Process.where(owner: User.last).match_path("*{10,20}.*Assembly, automated.*")
+Lca::Impact.match_path("*.Transport by truck.*")
+Lca::Exchange.match_path("*.Oil.*.Ecosphere.*").impacts.sum(:impact_amount)
+Lca::Product.match_path("*.ElectricVehicle.*").processes.match_path("*.Processing.*").where(location: "EU").impacts.match_path("*.Lithium.*").where(location: ["CN", "Africa"]).sum(:impact_amount)
         
-    # pg_ltree queries
-    User.last.lca_cycles.last.parent
-    Lca::Process.match_path("*.Manual assembly.*").children
+# pg_ltree queries
+User.last.lca_cycles.last.parent
+Lca::Process.match_path("*.Manual assembly.*").children
     
-    # pg_ltree combined with AR syntax
-    User.last.lca_cycles(type: "Lca::Product").children.match_path("*.Retail").children.exchanges
+# pg_ltree combined with AR syntax
+User.last.lca_cycles(type: "Lca::Product").children.match_path("*.Retail").children.exchanges
     
-    # all queries can be directed to a specific partition:
-    Lca::Process.owned_by( owner_id ).match_path("*.Recycling.*").where(impact_unit: "tons CO2/year").impacts.sum(:impact_amount)
+# all queries can be directed to a specific partition:
+Lca::Process.owned_by( owner_id ).match_path("*.Recycling.*").where(impact_unit: "tons CO2/year").impacts.sum(:impact_amount)
     
 ```
 
 The gem also creates some default models:
 
 ```ruby
-    Lca::Process::Transport::ByAir.match_path("*.CO2Emission.*").impacts.sum(:impact_amount)
-    Lca::Impact::Ecosphere::Fauna.match_path("*.ResourceExtraction.*").where(impact_unit: "Species killed/year").sum(:impact_amount)
+Lca::Process::Transport::ByAir.match_path("*.CO2Emission.*").impacts.sum(:impact_amount)
+Lca::Impact::Ecosphere::Fauna.match_path("*.ResourceExtraction.*").where(impact_unit: "Species killed/year").sum(:impact_amount)
 ```
 
 To see what syntax to use for path traversal please check out the following resources:
@@ -88,6 +88,21 @@ The LCA gem is designed to be compatible with PostgREST. PostgREST is an amazing
 
 If the `create_postgrest_roles` setting is on each new owner will be assigned a Postgres role allowing them to access data within their partition using PostgREST. Your owner model will be extended with a `.generate_jwt` method you can use to generate the PostgREST authentication token.
 
+## Caveats
+
+`pg_ltree` .child / .parent queries do not work across different models due to an ActiveRecord limitation that requires results to be related via inheritance. 
+
+The following behaviors have been observed:
+
+```ruby
+
+Lca::Process.last.children.impacts.where(impact_amount: 50)
+# => nil
+
+Lca::Process.last.children.unscope(where: :type).impacts.where(impact_amount: 50)
+# => ActiveRecord::SubclassNotFound (Invalid single-table inheritance type: Lca::Impact is not a subclass of Lca::Process)
+```
+
 ## Roadmap
 
 * .child / .parent query support across models unrelated through inheritance 

data/lib/generators/lca/templates/migration.rb.tt

@@ -14,19 +14,23 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
 	id serial,
 
 	owner_id integer,
-    owner_type text,
+	owner_type character varying,
+	
+	status integer,
 
-	data_external_id text,
-	data_provider text,
+	data_external_id character varying,
+	data_provider character varying,
 
-	type text,
+	type character varying,
 	name text,
 
 	parent_entity_id integer,
-	parent_entity_type text,
+	parent_entity_type character varying,
 
 	path ltree,
     	path_slug text,
+    	
+    	metadata_inline jsonb,
 
 	impact_amount decimal,
 	impact_amount_unit text,
@@ -57,5 +61,19 @@ SQL
     	execute "create role postgrest_anon nologin"
     	execute "grant postgrest_anon to #{ LCA_OPTIONS[:database_user] }"
     end
+
+
+
+    # 
+    create_table "#{ LCA_OPTIONS[:table_name] }_metadata" do |t|
+	t.string :model_type
+	t.integer :model_id
+	t.string :key
+	t.text :value
+	
+	t.timestamps
+    end
+    add_index "#{ LCA_OPTIONS[:table_name] }_metadata", [ :model_type, :model_id ]
+    add_index "#{ LCA_OPTIONS[:table_name] }_metadata", [ :key ]
   end
 end

data/lib/lca/active_record.rb

@@ -1,6 +1,6 @@
-# this still needed?
 # we include the concern manually so there should be no need for this anymore
-ActiveSupport.on_load(:active_record) do
-    puts "tf is AR still being extended?"
-    extend Lca::Lcable
-end
+# besides, no need to polute other classes with our stuff.
+
+# ActiveSupport.on_load(:active_record) do
+#     extend Lca::Lcable
+# end

data/lib/lca/models/concerns/statusable.rb

@@ -13,8 +13,13 @@ module Lca::Statusable
 	alias_method :disable!, :inactive!
 	alias_method :off!, :inactive!
 	alias_method :toggle?, :toggle_status!
+	
+	before_create :set_default_status
     end
 
+    def set_default_status
+	self.status ||= 1
+    end
 
     def toggle_status!
         if active?

data/lib/lca/models/metadata.rb

@@ -0,0 +1,12 @@
+class Lca::Metadata < ActiveRecord::Base
+
+    belongs_to :model, polymorphic: true, required: true
+
+    def self.table_name
+	return "#{ ::LCA_OPTIONS[:table_name] }_metadata" if defined? ::LCA_OPTIONS
+	return "lca_models_metadata"
+    end
+    
+    validates_presence_of :key
+
+end

data/lib/lca/models/model.rb

@@ -21,10 +21,13 @@ class Lca::Model < ActiveRecord::Base
     validates_presence_of :name, allow_blank: false
     validates_presence_of :path, allow_blank: false
 
+    has_many :metadata, class_name: "::Lca::Metadata", dependent: :destroy, as: :model
+
     before_validation :set_defaults
     def set_defaults
         self.path ||= name.delete(" ").gsub(/[^0-9a-z ]/i, '') if name
         self.path_slug = path.parameterize if path
+        self.metadata_inline ||= {}
     end
 
 

data/lib/lca/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lca
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/lib/lca.rb

@@ -8,6 +8,7 @@ require "pg_ltree"
 require_relative "lca/version"
 
 require_relative "lca/models/concerns/statusable"
+require_relative "lca/models/metadata"
 require_relative "lca/models/model"
 require_relative "lca/models/cycle"
 require_relative "lca/models/stage"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lca
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Nick @ Earthster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -118,6 +118,7 @@ files:
 - lib/lca/models/impact/human_health/cancer.rb
 - lib/lca/models/impact/technosphere.rb
 - lib/lca/models/impact/technosphere/resource_availability.rb
+- lib/lca/models/metadata.rb
 - lib/lca/models/model.rb
 - lib/lca/models/process.rb
 - lib/lca/models/process/raw_resource.rb