skimming 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d38d35c798f029c2f8331d2ff3f890ede872607567b65e2d4ae43dcbdc28d034
+  data.tar.gz: 6447c4b4c3d103c5b3458852d87216444a8bc9c985b1851ae45727678c375e38
+SHA512:
+  metadata.gz: 715fdc5fa8d1cb0519ac9e7b6696e102f3f245ba57bf6d7d8e08e89025e0ec060691bdfdac941de84422df17cd643032e745a91c8ffec7dc83a329de212a6380
+  data.tar.gz: 1e6e3d3a21855d2917790f56c50bd82579ec798f1392288febea4cf94bfbf704536e9ad2c0577f498bb0a24a88e3cb8afe6f9837f7510d67e5dd809dff1d2d41

data/.gitignore

@@ -0,0 +1 @@
+skimming-*

data/lib/generators/skimming_migration_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+
+class SkimmingMigrationGenerator < Rails::Generators::Base
+
+  def create_migration_file
+    create_file "db/migrate/#{Time.zone.now.strftime("%Y%m%d%H%M%S")}_skimming_migration.rb", migration_data
+  end
+
+  private
+
+  def migration_data
+<<MIGRATION
+  class SkimmingMigration < ActiveRecord::Migration[5.2]
+    # 0.0.1 Release
+    def change
+      unless table_exists? :collection_filters
+        create_table :collection_filters do |t|
+          t.string :object_name
+          t.string :rule
+
+          t.timestamps
+        end
+
+        #{generate_join_tables_creation_data}
+      end
+    end
+  end
+MIGRATION
+  end
+
+  def generate_join_tables_creation_data
+    join_tables_creation_data = ""
+    associations = Skimming.configuration.associations.keys
+
+    associations.each do |association|
+      join_tables_creation_data += "create_join_table :collection_filters, :#{association}#{"\n        " unless association == associations.last}"
+    end
+
+    join_tables_creation_data
+  end
+end

data/lib/models/skimming/collection_filter.rb

@@ -0,0 +1,11 @@
+module Skimming
+  class CollectionFilter < ActiveRecord::Base
+    Skimming.configuration.associations.each do |association_name, association_options|
+      has_and_belongs_to_many association_name.to_sym, class_name: association_options[:class_name], inverse_of: :collection_filters, foreign_key: "#{association_name}_id".to_sym
+    end
+
+    validates_presence_of :object_name, :rule
+
+    scope :for_object, -> (object_name) { where(object_name: object_name) }
+  end
+end

data/lib/skimming.rb

@@ -0,0 +1,6 @@
+require 'skimming/configuration'
+require 'skimming/model'
+require 'skimming/parasite_model'
+require 'skimming/skimmer'
+require 'models/skimming/collection_filter'
+require 'generators/skimming_migration_generator'

data/lib/skimming/configuration.rb

@@ -0,0 +1,18 @@
+module Skimming
+  def self.configuration
+    @configuration ||= Configuration.new(configuration_hash)
+  end
+
+  def self.configuration_hash
+    @configuration_hash ||= HashWithIndifferentAccess.new(YAML.load_file('config/skimming.yml'))
+  end
+
+  class Configuration
+    attr_accessor :associations, :options
+
+    def initialize(configuration_hash)
+      @associations = configuration_hash[:associations]
+      @options = configuration_hash[:options]
+    end
+  end
+end

data/lib/skimming/model.rb

@@ -0,0 +1,13 @@
+module Skimming
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      has_and_belongs_to_many :collection_filters, class_name: 'Skimming::CollectionFilter'
+    end
+
+    def skim(collection, object_name: nil, **skimming_instances)
+      Skimming::Skimmer.new(self, collection, object_name, skimming_instances).skim
+    end
+  end
+end

data/lib/skimming/parasite_model.rb

@@ -0,0 +1,15 @@
+module Skimming
+  module ParasiteModel
+    extend ActiveSupport::Concern
+
+    included do
+      Skimming.configuration.options[name.demodulize.underscore][:skim_through].each do |association_name|
+        has_many :collection_filters, through: association_name.to_sym, class_name: 'Skimming::CollectionFilter'
+      end
+    end
+
+    def skim(collection, through: nil, object_name: nil, **skimming_instances)
+      Skimming::Skimmer.new(self, collection, object_name, skimming_instances).skim_through through
+    end
+  end
+end

data/lib/skimming/skimmer.rb

@@ -0,0 +1,59 @@
+module Skimming
+  class Skimmer
+    attr_reader :subject, :collection, :collection_name, :skimming_instances
+
+    def initialize(subject, collection, object_name, skimming_instances)
+      @subject = subject
+      @collection = collection
+      @collection_name = object_name || calculate_collection_name
+      @skimming_instances = skimming_instances
+    end
+
+    def skim
+      set_instance_variables
+
+      filters_rules = subject.collection_filters.for_object(collection_name).map(&:rule)
+
+      return collection if filters_rules.empty?
+
+      skimming_result = collection.select do |collection_object|
+        instance_variable_set("@#{collection_object.class.name.downcase}", collection_object)
+
+        filters_rules.all? { |rule| eval rule }
+      end
+
+      skimming_result
+    end
+
+    def skim_through(skimming_associations)
+      set_instance_variables
+
+      skimming_associations = Skimming.configuration.options[subject.class.name.underscore][:skim_through] if skimming_associations.blank?
+      skimming_result = []
+
+      skimming_associations.each do |association_name|
+        subject.send(association_name.to_sym).each do |skimming_object|
+          skimming_result += skimming_object.skim(collection, subject.class.name.downcase.to_sym => subject)
+        end
+      end
+
+      skimming_result.uniq
+    end
+
+    private
+
+    def calculate_collection_name
+      raise 'Invalid collection: contains objects with different classes' unless collection.map(&:class).uniq.count == 1
+
+      collection.first.class.name.downcase
+    end
+
+    def set_instance_variables
+      instance_variable_set("@#{subject.class.name.downcase}", subject)
+
+      skimming_instances.each do |instance_name, instance_object|
+        instance_variable_set("@#{instance_name}", instance_object)
+      end
+    end
+  end
+end

data/skimming.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = 'skimming'
+  s.version     = '0.0.1'
+  s.date        = '2020-04-18'
+  s.summary     = "Collections skimming"
+  s.description = "Filter your collections with database-configurable rules"
+  s.authors     = ["Valerio Bellaveglia"]
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/ValerioBellaveglia/Skimming'
+  s.require_path = 'lib'
+  s.license = 'MIT'
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: skimming
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Valerio Bellaveglia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-18 00:00:00.000000000 Z
+dependencies: []
+description: Filter your collections with database-configurable rules
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- lib/generators/skimming_migration_generator.rb
+- lib/models/skimming/collection_filter.rb
+- lib/skimming.rb
+- lib/skimming/configuration.rb
+- lib/skimming/model.rb
+- lib/skimming/parasite_model.rb
+- lib/skimming/skimmer.rb
+- skimming.gemspec
+homepage: https://github.com/ValerioBellaveglia/Skimming
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Collections skimming
+test_files: []