lca 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9484c550eb1523766573047c009f2081526636c4918aeb29609fbc40885990b1
-  data.tar.gz: cd3266a10c9238189d327e7f92928c7c734094ae23d8dca999beb12342a13c75
+  metadata.gz: 62afb1561f978b69743ea334e439cc449375f0b4bc1cad29601b174a5d231a41
+  data.tar.gz: 1f18a6226d1fee18f3e2d226616c34dd3cae9ba99389ef9ffb17cf828c586e34
 SHA512:
-  metadata.gz: 6858541887aae952fad81721253a4b51cf64d2a880dd8cc311d4afc1b672ae7938331fbd9e1d2bbcd77d8d860db2bb4dbf2e438271db4b8ce0843b7b5206ca55
-  data.tar.gz: 9bf817a23784db18f4c60df38087c3a4409c938ee49d4634270a5aaaed0b50be0182a60ad03ddcba904e6964d65580b6d5ef4fe3c52de4698fdc85ac2297f511
+  metadata.gz: e190b6449f86a075d6582276747f6f17b1d617cf404f1db04ef7600f7ac9a84490d60535901a9b1e3fc212fb855b381fb80f78d583db391a159b27c75b63e9a3
+  data.tar.gz: b2fc67ead55300e549192c8f1b37e2971e11bc4da9ed08956ea46a601fc6aba1596a56106822f1b085e2c82d94560975bcc301ef8df3946121a331ddcd925a7f

data/Gemfile

@@ -9,4 +9,7 @@ gem "rspec", "~> 3.0"
 
 gem "activerecord", "~> 6.0"
 gem "activestorage", "~> 6.0"
-gem "actiontext", "~> 6.0"
+gem "actiontext", "~> 6.0"
+
+gem "jwt"
+gem "pg_ltree"

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,14 +88,30 @@ 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
 
-* more models for various LCA cycles, processes and impacts
+* .child / .parent query support across models unrelated through inheritance 
+* more model templates for various LCA cycles, processes and impacts
 * model validations
-* query objects, including postgres RECURSIVE queries
+* query objects
+* postgres RECURSIVE queries
 * builders
 * seeds/fixtures
-* automated tests
 
 
 ## Contributing

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_id integer,
-    parent_type text,
+	parent_entity_id integer,
+	parent_entity_type character varying,
 
 	path ltree,
     	path_slug text,
+    	
+    	metadata_inline jsonb,
 
 	impact_amount decimal,
 	impact_amount_unit text,
@@ -44,7 +48,7 @@ SQL
     add_index LCA_OPTIONS[:table_name], :id
     add_index LCA_OPTIONS[:table_name], :owner_id
     add_index LCA_OPTIONS[:table_name], :type
-    add_index LCA_OPTIONS[:table_name], :parent_id
+    add_index LCA_OPTIONS[:table_name], :parent_entity_id
 
     # next two indexes unfortunately can't be unique since a cycle can appear several times under an owner
     add_index LCA_OPTIONS[:table_name], :path, using: :gist
@@ -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/lcable.rb

@@ -12,7 +12,7 @@ module Lca
 
         included do
 
-    	    has_many :lca_cycles, class_name: "::Lca::Cycle", foreign_key: :owner_id, as: :owner
+    	    has_many :lca_cycles, class_name: "::Lca::Model", foreign_key: :owner_id, as: :owner
     	    after_create :lca_create_storage
     	    before_destroy :lca_delete_storage
 

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/cycle.rb

@@ -1,6 +1,6 @@
 class Lca::Cycle < Lca::Model
 
-    has_many :stages, class_name: "::Lca::Stage", foreign_key: :parent_id, dependent: :destroy
+    has_many :stages, class_name: "::Lca::Stage", foreign_key: :parent_entity_id, dependent: :destroy
 
     def subcycles
         ::Lca::Cycle.match_path("#{path}.*")

data/lib/lca/models/exchange.rb

@@ -1,4 +1,4 @@
 class Lca::Exchange < Lca::Model
-    belongs_to :process, class_name: "::Lca::Process", foreign_key: :parent_id
-    has_many :impacts, class_name: "::Lca::Impact", foreign_key: :parent_id, dependent: :destroy
+    belongs_to :process, class_name: "::Lca::Process", foreign_key: :parent_entity_id, required: true
+    has_many :impacts, class_name: "::Lca::Impact", foreign_key: :parent_entity_id, dependent: :destroy
 end

data/lib/lca/models/impact.rb

@@ -1,6 +1,6 @@
 class Lca::Impact < Lca::Model
-    belongs_to :exchange, class_name: "::Lca::Exchange", foreign_key: :parent_id
-    
+    belongs_to :exchange, class_name: "::Lca::Exchange", foreign_key: :parent_entity_id, required: true
+
     validates_presence_of :impact_amount
     validates_presence_of :impact_amount_unit, allow_blank: false
     validates_presence_of :impact_factor

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

@@ -4,12 +4,14 @@ class Lca::Model < ActiveRecord::Base
 
     self.primary_key = :id
 
+    ltree :path
+
     def self.table_name
         return ::LCA_OPTIONS[:table_name] if defined? ::LCA_OPTIONS
         return "lca_models"
     end
 
-    belongs_to :owner, polymorphic: :true
+    belongs_to :owner, polymorphic: :true, required: true
 
     scope :match_path, -> (some_path) { where("path ~ ?", "#{some_path}") }
 
@@ -19,10 +21,13 @@ class Lca::Model < ActiveRecord::Base
     validates_presence_of :name, allow_blank: false
     validates_presence_of :path, allow_blank: false
 
-    before_save :set_defaults
+    has_many :metadata, class_name: "::Lca::Metadata", dependent: :destroy, as: :model
+
+    before_validation :set_defaults
     def set_defaults
-        self.path ||= name.parameterize.gsub("-", ".")
-        self.path_slug = path.parameterize
+        self.path ||= name.delete(" ").gsub(/[^0-9a-z ]/i, '') if name
+        self.path_slug = path.parameterize if path
+        self.metadata_inline ||= {}
     end
 
 
@@ -57,6 +62,10 @@ class Lca::Model < ActiveRecord::Base
             class_name
         end
 
+	model_class.define_singleton_method(:sti_name) do
+	    original_class_name
+	end
+
         # override the STI name lmfao
         model_class.define_singleton_method(:find_sti_class) do |p|
             original_class_name.constantize

data/lib/lca/models/process.rb

@@ -1,10 +1,9 @@
 class Lca::Process < Lca::Model
 
-    has_many :exchanges, class_name: "::Lca::Exchange", foreign_key: :parent_id, dependent: :destroy
+    has_many :exchanges, class_name: "::Lca::Exchange", foreign_key: :parent_entity_id, dependent: :destroy
     has_many :impacts, through: :exchanges
-    belongs_to :stage, class_name: "::Lca::Stage", foreign_key: :parent_id
 
-    def subprocesses
-        ::Lca::Process.where("path ~ ?", "#{path}.*")
-    end
+    has_many :subprocesses, class_name: "::Lca::Process", foreign_key: :parent_entity_id, dependent: :destroy, as: :parent_entity
+    belongs_to :parent_entity, polymorphic: true, required: true
+
 end

data/lib/lca/models/stage.rb

@@ -1,6 +1,6 @@
 class Lca::Stage < Lca::Model
 
-    belongs_to :cycle, class_name: "::Lca::Cycle", foreign_key: :parent_id
-    has_many :processes, class_name: "::Lca::Process", foreign_key: :parent_id
+    belongs_to :cycle, class_name: "::Lca::Cycle", foreign_key: :parent_entity_id, required: true
+    has_many :processes, class_name: "::Lca::Process", foreign_key: :parent_entity_id
 
 end

data/lib/lca/version.rb

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

data/lib/lca.rb

@@ -3,9 +3,12 @@ require "active_support/all"
 
 require "active_record"
 
+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.1
+  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