activeadmin_active_resource 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90cbc4a293441580fae9b56c4ca2e5174df2c2e1db140a1e06be080e214af5e1
-  data.tar.gz: fffc4c46e2aa3c352d8d8e94fa0f6adb13b16ee2c094941484b5e7b4246c0981
+  metadata.gz: 99217ffe9d6e57fd4eda0bd713c760eafb6bf3418765e12ad0b5a76d8bc002cd
+  data.tar.gz: 2b41192fec46788df9075ec0d3cdff979f500b25d07e03158566b7b19a05e6f8
 SHA512:
-  metadata.gz: 7d17626dfce7aec903b32dc299856397bc01cfb92ec93ca4d133e46c52224a2bbf4527da5f64c157e63c1c8cb8ac125ff8a0f8215caebc1fed085eac2be5eccd
-  data.tar.gz: 92638fb4870396b7824eeefb47035285517b4f689a9416e2cd5ada29b9ef7d58d45eadb99c36ce0cdcc7b78ea731ba4d2babc7abef02bae1cf5f57c3b719e7e7
+  metadata.gz: 47692d3c049165f2e7b92bc272d7c555fdc04a69230be34eb6455c1c8b04ab4bc733487332752ba961b1cdcf23dfb9b3308083ce94a3615916ab827415e726a7
+  data.tar.gz: a1ea9e3409e76431f0a67f197ed54a7d7abbd1fdfd8978c3c4c89519f5fcdd9e47daff79e1b08d8dfa920b23200f8e7d3ca64264e62638c180e451ff815e8c9c

data/README.md

@@ -3,10 +3,10 @@
 
 An Active Admin plugin to use a REST API data source in place of a local database using [Active Resource](https://github.com/rails/activeresource).
 
-NOTICE: currently some Active Admin features don't work as expected:
-- Filters: partially supported (see example)
-- Form fields: some fields must be configured explicitly
-- Comments: not supported
+**NOTICE**: currently some Active Admin features don't work as expected:
+- Filters are partially supported (see example)
+- Some form fields must be configured explicitly (like the associations)
+- Comments are not supported
 
 ## Install
 - Add to your project's Gemfile (with Active Admin installed): `gem 'activeadmin_active_resource'`

data/lib/activeadmin/active_resource/base.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module ActiveResource
+    module Base
+      attr_writer :inheritance_column
+
+      # ref: https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/ClassMethods.html#method-i-column_for_attribute
+      def column_for_attribute(name)
+        # => ActiveRecord::ConnectionAdapters::Column
+        col_name = name.to_s
+        send(:class).columns.find { |col| col.name == col_name }
+      end
+
+      module ClassMethods
+        prepend(FindExt = Module.new do
+          def find(*arguments)
+            # First argument an array -> batch action
+            if arguments.count > 0 && arguments[0].is_a?(Array)
+              ret = []
+              arguments[0].each do |id|
+                ret << find(id)
+              end
+              ret.compact
+            else
+              super
+            end
+          end
+        end)
+
+        def _ransackers
+          {}
+        end
+
+        # ref: https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-content_columns
+        def content_columns
+          @content_columns ||= columns.reject do |c|
+            # c.name == primary_key || # required to update enities
+            c.name == inheritance_column ||
+              c.name.end_with?("_id") ||
+              c.name.end_with?("_count")
+          end
+        end
+
+        # ref: http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-column_names
+        def column_names
+          @column_names ||= columns.map(&:name)
+        end
+
+        # ref: http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-columns
+        def columns
+          # => array of ActiveRecord::ConnectionAdapters::Column
+          @columns ||= begin
+            schema.map do |name, type|
+              col_name = name.to_s
+              col_type = type.to_sym
+              col_type = :hidden if col_name == 'id'
+              OpenStruct.new(name: col_name, type: col_type)
+            end
+          end
+        end
+
+        def find_all(options = {})
+          prefix_options, query_options = split_options(options[:params])
+          query_options[:limit] = query_options[:per_page]
+          path = collection_path(prefix_options, query_options)
+          @connection_response = connection.get(path, headers)
+          instantiate_collection((format.decode( @connection_response.body ) || []), query_options, prefix_options)
+        end
+
+        # -> http://api.rubyonrails.org/classes/ActiveRecord/FinderMethods.html#method-i-find_by
+        def find_by(arg, *_args)
+          arg && arg['id'] ? find(arg['id']) : find(:first, arg)
+        end
+
+        # -> http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-inheritance_column
+        def inheritance_column
+          (@inheritance_column ||= nil) || 'type'
+        end
+
+        # -> http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-quoted_table_name
+        def quoted_table_name
+          @quoted_table_name ||= "\"#{to_s.tableize}\""
+        end
+
+        def page(page)
+          @page = page.to_i
+          @page = 1 if @page < 1
+          self
+        end
+
+        def per(page_count)
+          @per_page = page_count.to_i
+          results
+        end
+
+        def ransack(params = {}, _options = {})
+          @ransack_params = params.blank? ? {} : params.permit!.to_h
+          OpenStruct.new(conditions: {}, object: OpenStruct.new(klass: self), result: self)
+        end
+
+        # -> http://api.rubyonrails.org/classes/ActiveRecord/Reflection/ClassMethods.html#method-i-reflect_on_all_associations
+        def reflect_on_all_associations(_macro = nil)
+          []
+        end
+
+        # -> http://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-reorder
+        def reorder(sql)
+          @order = sql
+          self
+        end
+
+        def results
+          results = find_all params: { page: @page, per_page: @per_page, order: @order, q: @ransack_params }
+          decorate_with_pagination_data(results)
+        end
+
+        def decorate_with_pagination_data(results)
+          results.current_page = @page
+          results.limit_value = (@connection_response['pagination-limit'] || @per_page).to_i
+          results.total_count = (@connection_response['pagination-totalcount'] || results.count).to_i
+          results.total_pages = results.limit_value > 0 ? (results.total_count.to_f / results.limit_value).ceil : 1
+          results
+        end
+      end
+
+      def self.prepended(base)
+        base.collection_parser = ActiveAdmin::ActiveResource::Results
+
+        class << base
+          prepend ClassMethods
+        end  
+      end 
+    end
+  end
+end

data/lib/activeadmin/active_resource/connection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module ActiveResource
+    module Connection
+      # ref: https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Quoting.html#method-i-quote_column_name
+      def quote_column_name(column_name)
+        column_name.to_s
+      end
+    end
+  end
+end

data/lib/activeadmin/active_resource/engine.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'active_admin'
+require_relative 'base'
+require_relative 'connection'
 
 module ActiveAdmin
   module ActiveResource
@@ -11,133 +13,9 @@ module ActiveAdmin
 end
 
 ::ActiveResource::Base.class_eval do
-  attr_writer :inheritance_column
-
-  self.collection_parser = ActiveAdmin::ActiveResource::Results
-
-  # ref: https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/ClassMethods.html#method-i-column_for_attribute
-  def column_for_attribute(name)
-    # => ActiveRecord::ConnectionAdapters::Column
-    col_name = name.to_s
-    send(:class).columns.find { |col| col.name == col_name }
-  end
-
-  class << self
-    prepend(FindExt = Module.new do
-      def find(*arguments)
-        # First argument an array -> batch action
-        if arguments.count > 0 && arguments[0].is_a?(Array)
-          ret = []
-          arguments[0].each do |id|
-            ret << find(id)
-          end
-          ret.compact
-        else
-          super
-        end
-      end
-    end)
-
-    def _ransackers
-      {}
-    end
-
-    # ref: https://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-content_columns
-    def content_columns
-      @content_columns ||= columns.reject do |c|
-        # c.name == primary_key || # required to update enities
-        c.name == inheritance_column ||
-          c.name.end_with?("_id") ||
-          c.name.end_with?("_count")
-      end
-    end
-
-    # ref: http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-column_names
-    def column_names
-      @column_names ||= columns.map(&:name)
-    end
-
-    # ref: http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-columns
-    def columns
-      # => array of ActiveRecord::ConnectionAdapters::Column
-      @columns ||= begin
-        schema.map do |name, type|
-          col_name = name.to_s
-          col_type = type.to_sym
-          col_type = :hidden if col_name == 'id'
-          OpenStruct.new(name: col_name, type: col_type)
-        end
-      end
-    end
-
-    def find_all(options = {})
-      prefix_options, query_options = split_options(options[:params])
-      query_options[:limit] = query_options[:per_page]
-      path = collection_path(prefix_options, query_options)
-      @connection_response = connection.get(path, headers)
-      instantiate_collection((format.decode( @connection_response.body ) || []), query_options, prefix_options)
-    end
-
-    # -> http://api.rubyonrails.org/classes/ActiveRecord/FinderMethods.html#method-i-find_by
-    def find_by(arg, *_args)
-      arg && arg['id'] ? find(arg['id']) : find(:first, arg)
-    end
-
-    # -> http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-inheritance_column
-    def inheritance_column
-      (@inheritance_column ||= nil) || 'type'
-    end
-
-    # -> http://api.rubyonrails.org/classes/ActiveRecord/ModelSchema/ClassMethods.html#method-i-quoted_table_name
-    def quoted_table_name
-      @quoted_table_name ||= "\"#{to_s.tableize}\""
-    end
-
-    def page(page)
-      @page = page.to_i
-      @page = 1 if @page < 1
-      self
-    end
-
-    def per(page_count)
-      @per_page = page_count.to_i
-      results
-    end
-
-    def ransack(params = {}, _options = {})
-      @ransack_params = params.blank? ? {} : params.permit!.to_h
-      OpenStruct.new(conditions: {}, object: OpenStruct.new(klass: self), result: self)
-    end
-
-    # -> http://api.rubyonrails.org/classes/ActiveRecord/Reflection/ClassMethods.html#method-i-reflect_on_all_associations
-    def reflect_on_all_associations(_macro = nil)
-      []
-    end
-
-    # -> http://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-reorder
-    def reorder(sql)
-      @order = sql
-      self
-    end
-
-    def results
-      results = find_all params: { page: @page, per_page: @per_page, order: @order, q: @ransack_params }
-      decorate_with_pagination_data(results)
-    end
-
-    def decorate_with_pagination_data(results)
-      results.current_page = @page
-      results.limit_value = (@connection_response['pagination-limit'] || @per_page).to_i
-      results.total_count = (@connection_response['pagination-totalcount'] || results.count).to_i
-      results.total_pages = results.limit_value > 0 ? (results.total_count.to_f / results.limit_value).ceil : 1
-      results
-    end
-  end
+  prepend ActiveAdmin::ActiveResource::Base
 end
 
 ::ActiveResource::Connection.class_eval do
-  # ref: https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/Quoting.html#method-i-quote_column_name
-  def quote_column_name(column_name)
-    column_name.to_s
-  end
+  prepend ActiveAdmin::ActiveResource::Connection
 end

data/lib/activeadmin/active_resource/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveAdmin
   module ActiveResource
-    VERSION = '0.2.4'
+    VERSION = '0.2.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_active_resource
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -202,6 +202,8 @@ files:
 - README.md
 - Rakefile
 - lib/activeadmin/active_resource.rb
+- lib/activeadmin/active_resource/base.rb
+- lib/activeadmin/active_resource/connection.rb
 - lib/activeadmin/active_resource/engine.rb
 - lib/activeadmin/active_resource/results.rb
 - lib/activeadmin/active_resource/version.rb