lintity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfa928e67ae36f6fabd78f3ca81dfdb437d2b3c0a113cb5e04d8d08a19101dc4
+  data.tar.gz: 50cfef8c00bafcd82944e70b346b72b90ef0eb52587d59149f7e3a005df63da5
+SHA512:
+  metadata.gz: c52bec211f5442cca8e4422487dfd544de53ed105e28c2ff21179bdf96c777efe103cf4a260ab18accaa871b3fc2b79dd6de4bf5acd1ebe6ba6c79c2ac5ff97f
+  data.tar.gz: 68fbebac842f5042ffd78e67024dc61cfe92ec144cc614f58484257db1e50433b6e64d18a6dd5044d616a16f80c194b0d8ca632ec3228009b6d657b2c865aa2d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Rem
+
+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,76 @@
+# Lintity
+Training gem (Engine) that shows list of entities
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "lintity"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install lintity
+```
+## System Requirements
+  * Ruby >= 3.0
+  * Ruby On Rails >= 7.0
+  * gem 'importmap-rails'
+  * gem 'stimulus-rails'
+  * bootstrap 5
+  * gem 'font-awesome-rails'
+  * ActiveRecord
+
+## Usage
+Create your controller
+```ruby
+class CustomersController < Lintity::EntityListController #inherit
+  layout 'application'  #use own main layout
+  before_action :set_customer, only: [:edit]
+
+  def index
+    @search_path = customers_path
+    
+    @records = 
+      if @filter_field
+        Customer.where("#{@filter_field} #{@filter_sign} ?", @filter_value.to_i)  #implementing filter result
+      else
+        Customer.all
+      end
+  end
+
+  def edit; end
+
+  private
+
+  def init_fields  #your fields from model
+    @fields_settings = [
+      { field: 'name', name: 'Name', type: 'edit', path: Proc.new { |customer_id| edit_customer_path(id: customer_id) } },  #Add path for edit of a record
+      { field: 'phone', name: 'Phone', type: 'info' },
+      { field: 'address', name: 'Address', type: 'info' },
+      { field: 'ordered', name: 'Ordered', type: 'numeric_filter' },
+      { field: 'no_of_orders', name: 'No Of Orders', type: 'numeric_filter' },
+      { field: 'total_amount', name: 'Total Amount', type: 'numeric_filter' },
+    ]
+  end
+
+  def set_customer
+    @customer = Customer.find(params[:id])
+  end
+end
+```
+
+## Results
+  * Entity List View:
+![list](https://user-images.githubusercontent.com/14085661/172581037-c439c2f5-8c6b-4eb0-a5f0-21db755f427c.jpg)
+
+  * Filter
+![filter](https://user-images.githubusercontent.com/14085661/172581112-c98d9c0a-3c8c-4ee7-a651-9827435377cb.jpg)
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+#APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/lintity_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../stylesheets/lintity .css
+//= link_tree ../javascripts/lintity .js

data/app/assets/javascripts/lintity/application.js

@@ -0,0 +1 @@
+import * as jq from 'jquery';

data/app/assets/javascripts/lintity/controllers/entity_list_controller.js

@@ -0,0 +1,15 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["modal", "fieldvalue", "fieldcaption"]
+
+  numberic_filter({ params }) {
+    console.log(`field ${ params.field }`)
+
+    var myModal = new bootstrap.Modal(this.modalTarget)
+    this.fieldvalueTarget.id = params.field
+    this.fieldvalueTarget.name = params.field
+    this.fieldcaptionTarget.innerText = params.field
+    myModal.show()
+  }
+}

data/app/assets/stylesheets/lintity/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/lintity/application_controller.rb

@@ -0,0 +1,4 @@
+module Lintity
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/lintity/entity_list_controller.rb

@@ -0,0 +1,38 @@
+module Lintity
+  class EntityListController < ApplicationController
+    before_action :init_fields, only: [:index]
+    before_action :check_filters, only: [:index]
+
+    def index; end
+
+    private
+
+    def check_filters
+      filters = @fields_settings ? @fields_settings.select { |rec| rec[:type] == 'numeric_filter' } : []
+      filters.each do |filter_field_info|
+        break if check_filter_field(filter_field_info)
+      end
+    end
+
+    def check_filter_field(filter_field_info)
+      filter_name = filter_field_info[:field]
+      field_caption = filter_field_info[:name]
+      return nil unless params[filter_name]
+
+      @filter_field = filter_name.to_s
+      @filter_value = params[filter_name]
+      @filter_caption = field_caption
+
+      @filter_sign =
+        case params[:filter_option]
+        when 'more'
+          '>='
+        when 'less'
+          '<='
+        else
+          '='
+        end
+      @filter_field
+    end
+  end
+end

data/app/helpers/lintity/application_helper.rb

@@ -0,0 +1,4 @@
+module Lintity
+  module ApplicationHelper
+  end
+end

data/app/jobs/lintity/application_job.rb

@@ -0,0 +1,4 @@
+module Lintity
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/lintity/application_mailer.rb

@@ -0,0 +1,6 @@
+module Lintity
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/lintity/application_record.rb

@@ -0,0 +1,5 @@
+module Lintity
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/lintity/application.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Lintity</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "lintity/application", media: "all" %>
+  
+  <%= javascript_importmap_tags %>
+
+  <%= javascript_import_module_tag "lintity/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/lintity/entity_list/index.html.erb

@@ -0,0 +1,66 @@
+<div data-controller="entity-list">
+  <table class="table table-striped table-bordered">
+    <thead>
+      <tr>
+        <% @fields_settings.each do |field_info| %>
+          <th>
+            <%=
+              case field_info[:type]
+              when 'edit'
+                field_info[:name]
+              when 'info'
+                field_info[:name]
+              when 'numeric_filter'
+                button_tag "#{field_info[:name]}<i class=\"fa fa-filter #{ 'text-success' if @filter_field == field_info[:field] }\"></i>".html_safe, class: 'btn btn-link', data: {'entity-list-field-param'=>field_info[:field], 'action'=>"click->entity-list#numberic_filter"}
+              end
+            %>
+          </th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody>
+      <% @records.each do |record| %>
+        <tr class="table-row">
+          <% @fields_settings.each do |field_info| %>
+            <td>
+              <%=
+                case field_info[:type]
+                when 'edit'
+                  caption = record[field_info[:field]]
+                  link_to( caption ? caption : '(empty)', field_info[:path].call(record.id) )
+                when 'info', 'numeric_filter'
+                  record[field_info[:field]]
+                end              
+              %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <!-- Modal -->
+  <div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true" data-entity-list-target="modal">
+    <div class="modal-dialog">
+      <div class="modal-content">
+        <div class="modal-header">
+          <h5>Set Filter for "<span data-entity-list-target="fieldcaption"></span>"</h5>
+          <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+        </div>
+        <%= form_tag @search_path, method: :get, :enforce_utf8=>false do %>
+          <div class="modal-body">
+            <%= number_field_tag "field_replace", '', :class=>"form-control", :placeholder=>"Set filter value...", :autofocus=>'true', step: :any, 'data-entity-list-target'=>"fieldvalue" %>
+            <br/>
+            <%= select_tag :filter_option, options_from_collection_for_select([OpenStruct.new(id: 'eq', name: '='), OpenStruct.new(id: 'less', name: '<='), OpenStruct.new(id: 'more', name: '>=')], "id", "name"), :class=>"form-control" %>
+          
+          </div>
+          <div class="modal-footer">
+            <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+            <input type="submit" class="btn btn-primary" name="Save changes"/>
+          </div>
+        <% end %>        
+      </div>
+    </div>
+  </div>
+
+</div>

data/config/importmap.rb

@@ -0,0 +1,3 @@
+pin "jquery", to: "https://code.jquery.com/jquery-3.6.0.min.js", preload: true
+pin "lintity/application"
+pin_all_from Lintity::Engine.root.join("app/assets/javascripts/lintity/controllers"), under: "controllers", to: "lintity/controllers"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Lintity::Engine.routes.draw do
+  get 'entity_list/index'
+end

data/lib/lintity/engine.rb

@@ -0,0 +1,15 @@
+module Lintity
+  class Engine < ::Rails::Engine
+    isolate_namespace Lintity
+
+    initializer 'lintity.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+      app.config.importmap.cache_sweepers << root.join('app/assets/javascripts')
+    end
+
+    initializer 'lintity.assets' do |app|
+      app.config.assets.precompile += %w(lintity_manifest)
+    end
+
+  end
+end

data/lib/lintity/version.rb

@@ -0,0 +1,3 @@
+module Lintity
+  VERSION = "0.1.0"
+end

data/lib/lintity.rb

@@ -0,0 +1,6 @@
+require "lintity/version"
+require "lintity/engine"
+
+module Lintity
+  # Your code goes here...
+end

data/lib/tasks/lintity_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lintity do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: lintity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fat Shinobi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2.3
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails gem to create list of entities
+email:
+- r3mnik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/lintity_manifest.js
+- app/assets/javascripts/lintity/application.js
+- app/assets/javascripts/lintity/controllers/entity_list_controller.js
+- app/assets/stylesheets/lintity/application.css
+- app/controllers/lintity/application_controller.rb
+- app/controllers/lintity/entity_list_controller.rb
+- app/helpers/lintity/application_helper.rb
+- app/jobs/lintity/application_job.rb
+- app/mailers/lintity/application_mailer.rb
+- app/models/lintity/application_record.rb
+- app/views/layouts/lintity/application.html.erb
+- app/views/lintity/entity_list/index.html.erb
+- config/importmap.rb
+- config/routes.rb
+- lib/lintity.rb
+- lib/lintity/engine.rb
+- lib/lintity/version.rb
+- lib/tasks/lintity_tasks.rake
+homepage: https://github.com/fatshinobi/lintity
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fatshinobi/lintity
+  source_code_uri: https://github.com/fatshinobi/lintity
+  changelog_uri: https://github.com/fatshinobi/lintity
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Rails gem to create list of entities
+test_files: []