forest_liana 1.9.8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ce5ea697e568c0b4a0e09ab82d43f3282ca521d
-  data.tar.gz: 3c2f2d65713d2eebd007e8b43bbdbdc0566835ae
+  metadata.gz: 3afa4336e04821ea77f04fca3e91dee2151dfa58
+  data.tar.gz: 3260318c1d5da96ff29a4fac1fd6e1b4b28d101e
 SHA512:
-  metadata.gz: 27cfc6f40884c10ff33f1e8880ebdc8d834f5b627f5095093b56301e4ac30f4b9f8d9cd64ce33a687139229e58687a741829c95b7de6bbba50645c4cf870a524
-  data.tar.gz: 3fbb9eea9f7a0d75edd6eea0a037f66c2e43d99e31028b54e78bbed564a8d826a9ca0a8b89757a6e9d9120ef5aba6645f7d476b8698a077801d1452db220fb94
+  metadata.gz: 79e39acc9781c653d474631f89f09bd1570821b972f6a37c84ba3e8be829f8b4a7f3c67516944a5ae65ee654f4a2d047ee6d58dbbaddafc6699d9185686da02d
+  data.tar.gz: 551c111d11d8fbba8f00f7a115aae474fb35d950f3ef8f529c21c420e3c6eacc1d2b2f4e17cfd7a2ff8ccdbec5bfc3b0c0729c0e015816833d9c18c11a0eb678

data/app/controllers/forest_liana/associations_controller.rb

@@ -14,7 +14,7 @@ module ForestLiana
 
       respond_to do |format|
         format.json { render_jsonapi(getter) }
-        format.csv { render_csv(getter, @association) }
+        format.csv { render_csv(getter, @association.klass) }
       end
     end
 
@@ -71,8 +71,18 @@ module ForestLiana
       ResourceDeserializer.new(@resource, params[:resource], true).perform
     end
 
+    def is_sti_model?
+      @is_sti_model ||= (@association.klass.inheritance_column.present? &&
+        @association.klass.columns.any? { |column| column.name == @association.klass.inheritance_column })
+    end
+
+    def get_record record
+      is_sti_model? ? record.becomes(@association.klass) : record
+    end
+
     def render_jsonapi getter
-      render serializer: nil, json: serialize_models(getter.records,
+      records = getter.records.map { |record| get_record(record) }
+      render serializer: nil, json: serialize_models(records,
         include: getter.includes, count: getter.count, params: params)
     end
   end

data/app/controllers/forest_liana/resources_controller.rb

@@ -28,7 +28,7 @@ module ForestLiana
       getter.perform
 
       render serializer: nil, json:
-        serialize_model(getter.record, include: includes(getter))
+        serialize_model(get_record(getter.record), include: includes(getter))
     end
 
     def create
@@ -40,7 +40,7 @@ module ForestLiana
           creator.errors), status: 400
       elsif creator.record.valid?
         render serializer: nil,
-          json: serialize_model(creator.record, include: record_includes)
+          json: serialize_model(get_record(creator.record), include: record_includes)
       else
         render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
           creator.record.errors), status: 400
@@ -56,7 +56,7 @@ module ForestLiana
           updater.errors), status: 400
       elsif updater.record.valid?
         render serializer: nil,
-          json: serialize_model(updater.record, include: record_includes)
+          json: serialize_model(get_record(updater.record), include: record_includes)
       else
         render serializer: nil, json: JSONAPI::Serializer.serialize_errors(
           updater.record.errors), status: 400
@@ -65,7 +65,6 @@ module ForestLiana
 
     def destroy
       @resource.destroy(params[:id])
-
       head :no_content
     end
 
@@ -94,8 +93,18 @@ module ForestLiana
       head :not_found
     end
 
+    def is_sti_model?
+      @is_sti_model ||= (@resource.inheritance_column.present? &&
+        @resource.columns.any? { |column| column.name == @resource.inheritance_column })
+    end
+
+    def get_record record
+      is_sti_model? ? record.becomes(@resource) : record
+    end
+
     def render_jsonapi getter
-      render serializer: nil, json: serialize_models(getter.records,
+      records = getter.records.map { |record| get_record(record) }
+      render serializer: nil, json: serialize_models(records,
         include: includes(getter), count: getter.count, params: params)
     end
   end

data/app/controllers/forest_liana/router.rb

@@ -1,8 +1,7 @@
 class ForestLiana::Router
   def call(env)
     params = env['action_dispatch.request.path_parameters']
-    resource = ForestLiana::SchemaUtils.find_model_from_collection_name(
-      params[:collection])
+    resource = ForestLiana::SchemaUtils.find_model_from_collection_name(params[:collection])
 
     begin
       class_name = ForestLiana.name_for(resource).classify

data/app/models/forest_liana/model/collection.rb

@@ -6,7 +6,9 @@ class ForestLiana::Model::Collection
 
   attr_accessor :name, :fields, :actions, :segments, :only_for_relationships,
     :is_virtual, :is_read_only, :is_searchable, :display_name, :icon,
-    :integration, :pagination_type, :search_fields
+    :integration, :pagination_type, :search_fields,
+    # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+    :name_old
 
   def initialize(attributes = {})
     @actions = []

data/app/serializers/forest_liana/collection_serializer.rb

@@ -4,6 +4,7 @@ class ForestLiana::CollectionSerializer
   include JSONAPI::Serializer
 
   attribute :name
+  attribute :name_old # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
   attribute :display_name
   attribute :icon
   attribute :integration

data/app/services/forest_liana/base_getter.rb

@@ -1,9 +1,7 @@
 module ForestLiana
   class BaseGetter
-    def get_current_collection(table_name)
-      ForestLiana.apimap.find do |collection|
-        collection.name.to_s == table_name
-      end
+    def get_collection(collection_name)
+      ForestLiana.apimap.find { |collection| collection.name.to_s == collection_name }
     end
 
     def get_resource

data/app/services/forest_liana/has_many_getter.rb

@@ -5,7 +5,7 @@ module ForestLiana
       @association = association
       @params = params
       @field_names_requested = field_names_requested
-      @current_collection = get_current_collection(ForestLiana.name_for(model_association))
+      @collection = get_collection(ForestLiana.name_for(model_association))
     end
 
     def perform
@@ -19,8 +19,7 @@ module ForestLiana
 
     def search_query
       includesSymbols = includes.map { |association| association.to_sym }
-      SearchQueryBuilder.new(@records, @params,
-        includesSymbols, @current_collection).perform
+      SearchQueryBuilder.new(@records, @params, includesSymbols, @collection).perform
     end
 
     def includes

data/app/services/forest_liana/resources_getter.rb

@@ -4,7 +4,8 @@ module ForestLiana
       @resource = resource
       @params = params
       @count_needs_includes = false
-      @current_collection = get_current_collection(@resource.table_name)
+      @collection_name = ForestLiana.name_for(@resource)
+      @collection = get_collection(@collection_name)
       @field_names_requested = field_names_requested
       get_segment()
     end
@@ -49,8 +50,8 @@ module ForestLiana
         .map(&:name)
       includes_for_smart_search = []
 
-      if @current_collection && @current_collection.search_fields
-        includes_for_smart_search = @current_collection.search_fields
+      if @collection && @collection.search_fields
+        includes_for_smart_search = @collection.search_fields
           .select { |field| field.include? '.' }
           .map { |field| field.split('.').first.to_sym }
 
@@ -72,15 +73,14 @@ module ForestLiana
 
     def get_segment
       if @params[:segment]
-        @segment = @current_collection.segments.find do |segment|
+        @segment = @collection.segments.find do |segment|
           segment.name == @params[:segment]
         end
       end
     end
 
     def field_names_requested
-      collection_name = ForestLiana.name_for(@resource)
-      return nil unless @params[:fields] && @params[:fields][collection_name]
+      return nil unless @params[:fields] && @params[:fields][@collection_name]
 
       associations_for_query = []
 
@@ -100,12 +100,12 @@ module ForestLiana
         associations_for_query << @params[:sort].split('.').first.to_sym
       end
 
-      field_names = @params[:fields][collection_name].split(',').map { |name| name.to_sym }
+      field_names = @params[:fields][@collection_name].split(',').map { |name| name.to_sym }
       field_names | associations_for_query
     end
 
     def search_query
-      SearchQueryBuilder.new(@records, @params, includes, @current_collection).perform
+      SearchQueryBuilder.new(@records, @params, includes, @collection).perform
     end
 
     def sort_query

data/app/services/forest_liana/schema_adapter.rb

@@ -42,6 +42,20 @@ module ForestLiana
         end
       end
 
+      # NOTICE: Define an automatic segment for each STI child model.
+      if is_sti_parent?
+        column_type = @model.inheritance_column
+        @model.descendants.each do |submodel_sti|
+          type = submodel_sti.sti_name
+          name = type.pluralize
+          collection.segments << ForestLiana::Model::Segment.new({
+            id: name,
+            name: name,
+            where: lambda { { column_type => type } }
+          })
+        end
+      end
+
       collection
     end
 
@@ -49,13 +63,15 @@ module ForestLiana
 
     def collection
       @collection ||= begin
-        collection = ForestLiana.apimap.find do |x|
-          x.name.to_s == ForestLiana.name_for(@model)
+        collection = ForestLiana.apimap.find do |object|
+          object.name.to_s == ForestLiana.name_for(@model)
         end
 
         if collection.blank?
           collection = ForestLiana::Model::Collection.new({
             name: ForestLiana.name_for(@model),
+              # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+            name_old: ForestLiana.name_old_for(@model),
             fields: []
           })
 
@@ -73,7 +89,9 @@ module ForestLiana
 
     def add_columns
       @model.columns.each do |column|
-        collection.fields << get_schema_for_column(column)
+        unless is_sti_column_of_child_model?(column)
+          collection.fields << get_schema_for_column(column)
+        end
       end
 
       # NOTICE: Add Intercom fields
@@ -193,7 +211,7 @@ module ForestLiana
           # NOTICE: The foreign key exists, so it's a belongsTo relationship.
           elsif (field = column_association(collection, association)) &&
             [:has_one, :belongs_to].include?(association.macro)
-              field[:reference] = get_ref_for(association)
+              field[:reference] = get_reference_for(association)
               field[:field] = association.name
               field[:inverseOf] = inverse_of(association)
           # NOTICE: Create the fields of hasOne, HasMany, … relationships.
@@ -297,6 +315,17 @@ module ForestLiana
        column.name == @model.inheritance_column) || column.name == 'type'
     end
 
+    def is_sti_parent?
+      return false unless @model.try(:table_exists?)
+
+      @model.inheritance_column &&
+        @model.columns.find { |column| column.name == @model.inheritance_column }
+    end
+
+    def is_sti_column_of_child_model?(column)
+      sti_column?(column) && @model.descendants.empty?
+    end
+
     def add_default_value(column_schema, column)
       # TODO: detect/introspect the attribute default value with Rails 5
       #       ex: attribute :email, :string, default: 'arnaud@forestadmin.com'
@@ -398,11 +427,11 @@ module ForestLiana
       column_schema
     end
 
-    def get_ref_for(association)
+    def get_reference_for(association)
       if association.options[:polymorphic] == true
         '*.id'
       else
-        "#{ForestLiana.name_for(association.klass).underscore}.id"
+        "#{ForestLiana.name_for(association.klass)}.id"
       end
     end
 

data/app/services/forest_liana/schema_utils.rb

@@ -20,19 +20,23 @@ module ForestLiana
     end
 
     def self.find_model_from_collection_name(collection_name)
-      model = nil
-
-      ForestLiana.models.each do |subclass|
-        if subclass.abstract_class?
-          model = self.find_model_from_abstract_class(subclass, collection_name)
-        elsif ForestLiana.name_for(subclass) == collection_name
-          model = subclass.base_class
+      model_found = nil
+
+      ForestLiana.models.each do |model|
+        if model.abstract_class?
+          model_found = self.find_model_from_abstract_class(model, collection_name)
+        elsif ForestLiana.name_for(model) == collection_name
+          if self.sti_child?(model)
+            model_found = model
+          else
+            model_found = model.base_class
+          end
         end
 
-        break if model
+        break if model_found
       end
 
-      model
+      model_found
     end
 
     def self.tables_names
@@ -74,11 +78,12 @@ module ForestLiana
     def self.sti_child?(model)
       begin
         parent = model.try(:superclass)
+        return false unless parent.try(:table_name)
 
         if ForestLiana.name_for(parent)
-          inheritance_column = parent.columns.find do |c|
-            (parent.inheritance_column && c.name == parent.inheritance_column)\
-              || c.name == 'type'
+          inheritance_column = parent.columns.find do |column|
+            (parent.inheritance_column && column.name == parent.inheritance_column)\
+              || column.name == 'type'
           end
 
           return inheritance_column.present?

data/lib/forest_liana.rb

@@ -21,6 +21,8 @@ module ForestLiana
   mattr_accessor :included_models
   mattr_accessor :user_class_name
   mattr_accessor :names_overriden
+  # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+  mattr_accessor :names_old_overriden
 
   self.apimap = []
   self.allowed_users = []
@@ -30,14 +32,22 @@ module ForestLiana
   self.user_class_name = nil
   self.names_overriden = {}
 
+  # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+  self.names_old_overriden = {}
+
   def self.schema_for_resource resource
     self.apimap.find do |collection|
       SchemaUtils.find_model_from_collection_name(collection.name)
-        .try(:table_name) == resource.table_name
+        .try(:name) == resource.name
     end
   end
 
   def self.name_for(model)
-    self.names_overriden[model] || model.try(:table_name)
+    self.names_overriden[model] || model.try(:name)
+  end
+
+  # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+  def self.name_old_for(model)
+    self.names_old_overriden[model] || model.try(:table_name)
   end
 end

data/lib/forest_liana/bootstraper.rb

@@ -32,9 +32,15 @@ module ForestLiana
 
     private
 
+    def is_sti_parent_model?(model)
+      return false unless model.try(:table_exists?)
+
+      model.inheritance_column && model.columns.find { |column| column.name == model.inheritance_column }
+    end
+
     def analyze_model?(model)
       model && model.table_exists? && !SchemaUtils.habtm?(model) &&
-        SchemaUtils.model_included?(model) && !SchemaUtils.sti_child?(model)
+        SchemaUtils.model_included?(model)
     end
 
     def fetch_models
@@ -46,6 +52,10 @@ module ForestLiana
         if model.abstract_class?
           model.descendants.each { |submodel| fetch_model(submodel) }
         else
+          if is_sti_parent_model?(model)
+            model.descendants.each { |submodel_sti| fetch_model(submodel_sti) }
+          end
+
           if analyze_model?(model)
             ForestLiana.models << model
           end
@@ -105,15 +115,18 @@ module ForestLiana
 
     def namespace_duplicated_models
       ForestLiana.models
-        .group_by {|model| model.table_name}
-        .select {|table_name, models| models.length > 1}
+        .group_by { |model| model.table_name }
+        .select { |table_name, models| models.length > 1 }
         .try(:each) do |table_name, models|
           models.each do |model|
-            ForestLiana.names_overriden[model] =
+            unless model.name.deconstantize.blank?
+              ForestLiana.names_overriden[model] = model.name.gsub('::', '__')
+            end
+            # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+            ForestLiana.names_old_overriden[model] =
               "#{model.name.deconstantize.downcase}__#{model.table_name}"
           end
         end
-
     end
 
     def create_apimap
@@ -149,7 +162,7 @@ module ForestLiana
           "Can you check on Forest that you copied it properly in the " \
           "forest_liana initializer?"
       else
-        json = JSONAPI::Serializer.serialize(ForestLiana.apimap, {
+        apimap = JSONAPI::Serializer.serialize(ForestLiana.apimap, {
           is_collection: true,
           include: ['actions', 'segments'],
           meta: {
@@ -168,7 +181,7 @@ module ForestLiana
           http.use_ssl = true if forest_url.start_with?('https')
           http.start do |client|
             request = Net::HTTP::Post.new(uri.path)
-            request.body = json.to_json
+            request.body = apimap.to_json
             request['Content-Type'] = 'application/json'
             request['forest-secret-key'] = ForestLiana.env_secret
             response = client.request(request)
@@ -206,10 +219,13 @@ module ForestLiana
 
     def setup_intercom_integration(collection_name)
       model_name = ForestLiana.name_for(collection_name.constantize)
+      # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+      model_name_old = ForestLiana.name_old_for(collection_name.constantize)
       collection_display_name = collection_name.capitalize
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_intercom_conversations",
+        name_old: "#{model_name_old}_intercom_conversations",
         display_name: collection_display_name + ' Conversations',
         icon: 'intercom',
         integration: 'intercom',
@@ -227,6 +243,7 @@ module ForestLiana
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_intercom_attributes",
+        name_old: "#{model_name_old}_intercom_attributes",
         display_name: collection_display_name + ' Attributes',
         icon: 'intercom',
         integration: 'intercom',
@@ -270,10 +287,13 @@ module ForestLiana
     def setup_stripe_integration(collection_name_and_field)
       collection_name = collection_name_and_field.split('.')[0]
       model_name = ForestLiana.name_for(collection_name.constantize)
+      # TODO: Remove once lianas prior to 2.0.0 are not supported anymore.
+      model_name_old = ForestLiana.name_old_for(collection_name.constantize)
       collection_display_name = model_name.capitalize
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_stripe_payments",
+        name_old: "#{model_name_old}_stripe_payments",
         display_name: collection_display_name + ' Payments',
         icon: 'stripe',
         integration: 'stripe',
@@ -307,6 +327,7 @@ module ForestLiana
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_stripe_invoices",
+        name_old: "#{model_name_old}_stripe_invoices",
         display_name: collection_display_name + ' Invoices',
         icon: 'stripe',
         integration: 'stripe',
@@ -341,6 +362,7 @@ module ForestLiana
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_stripe_cards",
+        name_old: "#{model_name_old}_stripe_cards",
         display_name: collection_display_name + ' Cards',
         icon: 'stripe',
         integration: 'stripe',
@@ -376,6 +398,7 @@ module ForestLiana
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_stripe_subscriptions",
+        name_old: "#{model_name_old}_stripe_subscriptions",
         display_name: collection_display_name + ' Subscriptions',
         icon: 'stripe',
         integration: 'stripe',
@@ -409,6 +432,7 @@ module ForestLiana
 
       ForestLiana.apimap << ForestLiana::Model::Collection.new({
         name: "#{model_name}_stripe_bank_accounts",
+        name_old: "#{model_name_old}_stripe_bank_accounts",
         display_name: collection_display_name + ' Bank Accounts',
         icon: 'stripe',
         integration: 'stripe',