active_resourceable 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3871f317828c3c6384cef4b7989929fc00ec45da1b6542ee7871b552b523238
+  data.tar.gz: 8ab803621f88abfd564262797edd806453cfba42e3878a76c3ae3ae4694a0f5d
+SHA512:
+  metadata.gz: 0adaacc5b2a3d81e6749925a7c08673c78644e3c90635ee86d0280b225e892ffa7b9c207fe156588b327b137ea3727ffcac9a2c8e079a466ec8048bc083ab1e2
+  data.tar.gz: c63d668b2959dd2fbdf03915545c3796c57e87c0a0ca35865b3883dfa18bb01795b2bbc12c1f8e6352a455ad7e60248bb0b59cee30238862cbd883368732bc01

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Adam Hess
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Active Resourceable
+
+A tiny framework built on top of Rails in order to help developers focus on writing important business logic. It should be used with hotwired

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/**/*_test.rb"]
+  test.warning = false
+end
+
+task default: :test

data/app/controllers/concerns/active_resourceable/resourceable.rb

@@ -0,0 +1,113 @@
+module ActiveResourceable::Resourceable
+  extend ActiveSupport::Concern
+  included do
+  end
+
+  class_methods do
+
+    def resource_model name, **opt
+
+      model_class = name.to_s.classify.constantize if name.is_a? Symbol
+      model_class = name.classify.constantize if name.is_a? String
+      model_class = name if name.is_a? Class and name.ancestors.include? ActiveRecord::Base
+      raise "Unable to identify resource model" if model_class.nil?
+      model_name = model_class.name.singularize.downcase
+
+      filter_set = opt[:filter_set]
+
+      filter_set.each do |filter_attr, filter_opt|
+        filter_on filter_attr, **filter_opt
+      end unless filter_set.nil?
+
+      sort_set = opt[:sort_set]
+
+      sort_set.each do |sort_attr, sort_opt|
+        sort_on sort_attr, **sort_opt
+      end unless sort_set.nil?
+
+      define_method("list_#{model_name.pluralize}") do
+        @pagy, collection = pagy(filtrate(model_class.readable_for(access_object)))
+        instance_variable_set :"@#{model_name.pluralize}", collection
+      end
+
+      define_method("show_#{model_name}") do
+        instance = model_class.readable_for(access_object).find(params[:id])
+        instance.access_object = access_object
+        instance_variable_set :"@#{model_name}", instance
+      end
+
+      define_method("new_#{model_name}") do
+        instance = model_class.new
+        instance.access_object = access_object
+        instance_variable_set :"@#{model_name}", instance
+      end
+
+      define_method("create_#{model_name}") do
+        instance = model_class.new
+        instance_variable_set :"@#{model_name}", instance
+        instance.access_object = access_object
+        instance.assign_attributes send("#{model_name}_params")
+        instance.save
+        render :new, status: :unprocessable_entity unless instance_variable_get(:"@#{model_name}").valid?
+      end
+
+      define_method("edit_#{model_name}") do
+        instance = model_class.editable_for(access_object).find(params[:id])
+        instance.access_object = access_object
+        instance_variable_set :"@#{model_name}", instance
+      end
+
+      define_method("update_#{model_name}") do
+        instance = model_class.editable_for(access_object).find(params[:id])
+        instance.access_object = access_object
+        instance_variable_set :"@#{model_name}", instance
+        instance.assign_attributes send("#{model_name}_params")
+        instance.save
+        render :edit, status: :unprocessable_entity unless instance_variable_get(:"@#{model_name}").valid?
+      end
+
+      define_method("destroy_#{model_name}") do
+        instance = model_class.deletable_for(access_object).find(params[:id])
+        instance.access_object = access_object
+        instance.destroy
+        instance_variable_set :"@#{model_name}", instance
+      end
+
+      define_method("#{model_name}_params") do
+        instance = instance_variable_get(:"@#{model_name}")
+        fields = instance.accessable_fields
+        send("#{model_name}_attrs", params.fetch(model_name, {}).permit(fields), fields)
+      end
+
+      alias_method "#{model_name}_args", "#{model_name}_params"
+
+      define_method("#{model_name}_attrs") do |object_params, fields|
+        (fields.include?(:user_id) and access_object.present?) ? object_params.merge(user_id: access_object.id) : object_params
+      end
+
+      define_method(:access_object) do
+        @access.authenticated_user
+      end
+
+      define_method(:filter_params) do
+        params.fetch(:filters, {}).permit(*filter_set.keys)
+      end
+
+      define_method(:sort_params) do
+        params.permit(:sort)
+      end
+
+      alias_method :user_object, :access_object
+
+      before_action :"list_#{model_name.pluralize}", only: %i[index]
+      before_action :"show_#{model_name}", only: %i[show]
+      before_action :"new_#{model_name}", only: %i[new]
+      before_action :"create_#{model_name}", only: %i[create]
+      before_action :"edit_#{model_name}", only: %i[edit]
+      before_action :"update_#{model_name}", only: %i[update]
+      before_action :"destroy_#{model_name}", only: %i[destroy]
+
+    end
+
+  end
+end

data/app/helpers/active_resourceable/app_form_builder.rb

@@ -0,0 +1,19 @@
+class ActiveResourceable::AppFormBuilder < ActionView::Helpers::FormBuilder
+
+  Dir.glob("#{Rails.root}/app/views/app_form_builder/*").each do |view_path|
+    field = view_path.split('/')[-1].split('.')[0][1..-1]
+    define_method(field) do |*args, **kwargs, &block|
+      @template.render partial: "/app_form_builder/#{field}", locals: { args: args, kwargs: kwargs, block: block, field: self }
+    end
+  end
+
+  def is_required method
+    @object.class.validators_on(method).any? do |validator|
+      validator.class == ActiveRecord::Validations::PresenceValidator
+    end unless @object.nil?
+  end
+
+  def should_display_input? method, access_object
+    @object.accessable_fields.any? { |attr| attr.is_a?(Hash) ? attr.keys.first.to_s == "#{method}_attributes" : attr == method }
+  end
+end

data/app/jobs/active_resourceable/active_record_instance_method_job.rb

@@ -0,0 +1,7 @@
+class ActiveResourceable::ActiveRecordInstanceMethodJob < ApplicationJob
+  queue_as :default
+
+  def perform(instance, method, *args)
+    instance.send "#{method}_sync", *args
+  end
+end

data/app/jobs/active_resourceable/active_record_instance_method_job_unique_until_executing_job.rb

@@ -0,0 +1,8 @@
+class ActiveResourceable::ActiveRecordInstanceMethodJobUniqueUntilExecutingJob < ApplicationJob
+  queue_as :default
+  unique :until_executing, on_conflict: ->(job) {}
+
+  def perform(instance, method, *args)
+    instance.send "#{method}_sync", *args
+  end
+end

data/app/models/concerns/active_resourceable/asyncable.rb

@@ -0,0 +1,21 @@
+module ActiveResourceable::Asyncable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def async_method method, options = {}
+      alias_method :"#{method}_sync", :"#{method}"
+
+      define_method(:"#{method}") do |*args|
+        ActiveResourceable::ActiveRecordInstanceMethodJob.set(**options).perform_later(self, method, *args)
+      end
+    end
+
+    def async_method_unique_until_executing method, options = {}
+      alias_method :"#{method}_sync", :"#{method}"
+
+      define_method(:"#{method}") do |*args|
+        ActiveResourceable::ActiveRecordInstanceMethodJobUniqueUntilExecutingJob.set(**options).perform_later(self, method, *args)
+      end
+    end
+  end
+end

data/app/models/concerns/active_resourceable/governable.rb

@@ -0,0 +1,26 @@
+module ActiveResourceable::Governable
+  extend ActiveSupport::Concern
+
+  included do
+
+    attr_accessor :access_object
+
+#   scope :editable_for, ->(user) {
+#     where(false)
+#   }
+#
+#   scope :readable_for, ->(user) {
+#     editable_for user
+#   }
+#
+#   scope :deletable_for, ->(user) {
+#     editable_for user
+#   }
+
+  end
+
+  def accessable_fields
+    raise NotImplementedError
+  end
+
+end

data/app/models/concerns/active_resourceable/sessionable.rb

@@ -0,0 +1,66 @@
+class ActiveResourceable::Sessionable < Module
+  extend ActiveSupport::Concern
+
+  def initialize(attrs)
+    @session_attrs = attrs
+  end
+
+  def included(base)
+    session_attrs = @session_attrs
+
+    base.class_eval do
+
+      attr_accessor :session
+
+      define_method(:session_attrs) do
+        session_attrs
+      end
+
+      def delete_session *attrs
+        attrs = session_attrs if attrs.empty?
+        attrs.each do |name, opt|
+          send(:"delete_#{name}")
+        end
+      end
+
+      session_attrs.each do |name, opt|
+
+        define_method(:"session_name_for_#{name}") do
+          "#{self.class.name.tableize}_#{name}"
+        end
+
+        define_method(:"modified_at_session_name_for_#{name}") do
+          "#{self.class.name.tableize}_#{name}_modified_at"
+        end
+
+        define_method(name) do
+          raise "Session is not set" if self.session.nil?
+          is_expired = send(:"is_#{name}_expired?")
+          is_expired ? nil : self.session[send(:"session_name_for_#{name}")]
+        end
+
+        define_method(:"#{name}=") do |value|
+          raise "Session is not set" if self.session.nil?
+          self.session[send(:"session_name_for_#{name}")] = value
+          self.session[send(:"modified_at_session_name_for_#{name}")] = Time.now
+        end
+
+        define_method(:"delete_#{name}") do
+          raise "Session is not set" if self.session.nil?
+          self.session.delete send(:"modified_at_session_name_for_#{name}")
+          self.session.delete send(:"session_name_for_#{name}")
+        end
+
+        define_method(:"is_#{name}_expired?") do
+          raise "Session is not set" if self.session.nil?
+          modified_at = self.session[send(:"modified_at_session_name_for_#{name}")]
+          (not opt[:expire_after].nil? and not modified_at.nil?) ? modified_at.to_datetime + opt[:expire_after] < Time.now : false
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/active_resourceable/engine.rb

@@ -0,0 +1,40 @@
+require "rails/engine"
+require "pagy"
+require "procore-sift"
+
+module ActiveResourceable
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveResourceable
+    engine_name "active_resourceable"
+    config.eager_load_namespaces << ActiveResourceable
+    config.active_resourceable = ActiveSupport::OrderedOptions.new
+    config.autoload_once_paths = %W(
+      #{root}/app/channels
+      #{root}/app/controllers
+      #{root}/app/controllers/concerns
+      #{root}/app/helpers
+      #{root}/app/models
+      #{root}/app/models/concerns
+      #{root}/app/jobs
+    )
+    
+    initializer "active_resourceable.resourceable", before: :load_config_initializers do
+      ActiveSupport.on_load(:action_controller_base) do
+        default_form_builder ActiveResourceable::AppFormBuilder
+        include Pagy::Backend
+        include Sift
+        include ActiveResourceable::Resourceable
+      end
+    end
+
+    initializer "active_resourceable.models_concerns" do
+      ActiveSupport.on_load(:active_record) do
+        include ActiveResourceable::Governable
+        include ActiveResourceable::Asyncable
+        scope :unpaginate, ->() {
+          offset(nil).limit(nil)
+        }
+      end
+    end
+  end
+end

data/lib/active_resourceable/version.rb

@@ -0,0 +1,3 @@
+module ActiveResourceable
+  VERSION = "0.0.0".freeze
+end

data/lib/active_resourceable.rb

@@ -0,0 +1,5 @@
+require "active_resourceable/engine"
+
+module ActiveResourceable
+  extend ActiveSupport::Autoload
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: active_resourceable
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Abdullah Dahmash
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: procore-sift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activejob-uniqueness
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: A tiny framework built on top of Rails in order to help developers focus
+  on writing important business logic. It should be used with hotwired
+email:
+- a@and.sa
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/active_resourceable/resourceable.rb
+- app/helpers/active_resourceable/app_form_builder.rb
+- app/jobs/active_resourceable/active_record_instance_method_job.rb
+- app/jobs/active_resourceable/active_record_instance_method_job_unique_until_executing_job.rb
+- app/models/concerns/active_resourceable/asyncable.rb
+- app/models/concerns/active_resourceable/governable.rb
+- app/models/concerns/active_resourceable/sessionable.rb
+- lib/active_resourceable.rb
+- lib/active_resourceable/engine.rb
+- lib/active_resourceable/version.rb
+homepage: https://github.com/AbdullahDahmash/active_resourceable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Active Resourceable
+test_files: []