angsa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b7ac88bfda0d089508dedc70127219c25598afa1f987f08e724fc6bdcbd2320
+  data.tar.gz: 47bb55cb83f05d9a991f6e2437f60dec4c103ebfbc591187a152dabf194017c4
+SHA512:
+  metadata.gz: 720ec9bf7509e0354722fb46a22df70f6ed1171544f4b2253363479effd43f936399fa2e831fd20ec86ca3df9b966e561fd89c5a55d6e62677c01cd08b716067
+  data.tar.gz: 56b9368d85618471312599f2ffb215327a1214953b6c7b0ade745667fcd4cb4e865eed516de2ceab07bb917589d0b4470c093bb70ba360d016d9f93c03558a3b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kennedy@elevateacademy.my. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in angsa.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kennedy Wee
+
+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,37 @@
+# Angsa
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/angsa`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add angsa
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install angsa
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/angsa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/angsa/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Angsa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/angsa/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/angsa/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'pagination'
+require_relative 'sorting'
+require_relative 'searching'
+
+module Angsa
+  class Base
+    include Pagination
+    include Sorting
+    include Searching
+
+    attr_reader :params, :model
+    def initialize(params, model)
+      @params = params
+      @model = model
+    end
+
+    def columns
+      raise NotImplementedError, 'columns is not implemented in derived class'
+    end
+
+    def associations
+      columns.map { |column| column[:source].to_s.split('.').first if column[:source].to_s.include?('.') }.compact.uniq
+    end
+
+    def data_model
+      records = model.all
+      records = records.includes(*associations) if associations.any?
+      apply_search(records, params)
+    end
+    
+    def data
+      records = data_model
+      records = apply_sorting(records, params)
+      records = apply_pagination(records, params)
+      extract_records(records)
+    end
+    
+    def extract_records(records)
+      records.map do |record|
+        columns.map do |column|
+          source = column[:source].split('.')
+          [column[:name], source.size == 1 ? record.send(source.first) : record.send(source.first).send(source.last)]
+        end.to_h
+      end
+    end
+
+    def as_json(*)
+      {
+        total: total_count,
+        data: data,
+      }
+    end
+
+    def total_count
+      data_model.count
+    end
+
+    def print_columns
+      puts columns
+    end
+  end
+end
+

data/lib/angsa/pagination.rb

@@ -0,0 +1,10 @@
+module Angsa
+  module Pagination
+    def apply_pagination(records, params)
+      limit = params[:limit] || 10
+      offset = params[:offset] || 0
+      
+      records.limit(limit).offset(offset)
+    end
+  end
+end

data/lib/angsa/searching.rb

@@ -0,0 +1,44 @@
+module Angsa
+  module Searching
+    def apply_search(records, params)
+      return records unless params[:search]
+    
+      conditions, values, associations = build_search_conditions_values_and_associations(columns, records, params)
+  
+      associations.each do |association|
+        records = records.joins(association.to_sym)
+      end
+  
+      records.where(conditions.join(' OR '), values)
+    end
+
+    def build_search_conditions_values_and_associations(columns, records, params)
+      conditions = []
+      values = {}
+      associations = []
+    
+      columns.each do |column|
+        next unless column[:searchable]  # Skip columns that aren't searchable
+    
+        source_parts = column[:source].split('.')
+        if source_parts.size == 1
+          # This is an attribute of the Course model
+          if column[:type] == :string
+            conditions << "LOWER(#{records.all.table_name}.#{source_parts.first}) LIKE :search"
+          end
+        else
+          # This is an attribute of an associated model
+          association, attribute = source_parts
+          if column[:type] == :string
+            conditions << "LOWER(#{association.pluralize}.#{attribute}) LIKE :search"
+            associations << association
+          end
+        end
+      end
+    
+      values[:search] = "%#{params[:search].downcase}%"
+      
+      return conditions, values, associations.uniq
+    end
+  end
+end

data/lib/angsa/sorting.rb

@@ -0,0 +1,20 @@
+module Angsa
+  module Sorting
+    def apply_sorting(records, params)
+      if params[:order] && params[:dir]
+        sort = columns.find { |column| column[:name].to_s == params[:order] }
+        if sort
+          if sort[:source].include?('.')
+            # This is an attribute of an associated model
+            association, attribute = sort[:source].split('.')
+            records = records.joins(association.to_sym).order("#{association.pluralize}.#{attribute} #{params[:dir]}")
+          else
+            # This is an attribute of the Course model
+            records = records.order("#{sort[:source]} #{params[:dir]}")
+          end
+        end
+      end
+      records
+    end
+  end
+end

data/lib/angsa/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Angsa
+  VERSION = "0.1.0"
+end

data/lib/angsa.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'angsa/version'
+require_relative 'angsa/base'
+
+module Angsa
+  class Error < StandardError; end
+end

data/lib/generators/angsa/install_generator.rb

@@ -0,0 +1,9 @@
+module Angsa
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_base_controller
+      copy_file 'angsa_gridjs_controller.js', 'app/javascript/controllers/angsa_gridjs_controller.js'
+    end
+  end
+end

data/lib/generators/angsa/js_generator.rb

@@ -0,0 +1,36 @@
+module Angsa
+  class JsGenerator < Rails::Generators::Base
+    desc 'Generate the stimulus controller based on the table setup.'
+    source_root File.expand_path('templates', __dir__)
+    argument :model, type: :string
+
+    # main function to generate based on setup
+    def generate_stimulus_controller
+      angsa_class = "#{model}Angsa".constantize.new(nil)
+      @columns = angsa_class.columns.map { |col| col[:name].to_s.capitalize }
+
+      template 'angsa_stimulus_controller.js', File.join('app', 'javascript', 'controllers', "#{stimulus_controller_path}.js")
+    end
+
+    # make the class name
+    def stimulus_controller_name
+      stimulus_controller_path.classify
+    end
+
+    def angsa_api_url
+      model_name
+    end
+
+    private
+    
+    # for the controller path
+    def stimulus_controller_path
+      "#{model.underscore}_angsa_controller"
+    end
+
+    # get the model name
+    def model_name
+      "#{model.downcase}"
+    end
+  end
+end

data/lib/generators/angsa/table_generator.rb

@@ -0,0 +1,24 @@
+module Angsa
+  class TableGenerator < Rails::Generators::Base
+    desc 'Generate table setup for a model'
+    source_root File.expand_path('templates', __dir__)
+    argument :model, type: :string
+
+    def generate_table_setup
+      template 'table_setup.rb', File.join('app', 'angsa', "#{setup_table_path}.rb")
+    end
+
+    private
+    def setup_table_path
+      "#{model.downcase}_angsa"
+    end
+
+    def model_class_name
+      "#{model.classify}Angsa"
+    end
+
+    def model_name
+      "#{model}"
+    end
+  end
+end

data/lib/generators/angsa/templates/angsa_gridjs_controller.js

@@ -0,0 +1,119 @@
+import { Controller } from '@hotwired/stimulus';
+import { Grid } from 'gridjs';
+
+export default class AngsaGridjsController extends Controller {
+  connect() {
+    this.initializeGrid();
+  }
+
+  initializeGrid() {
+    const grid = new Grid({
+      language: this.languageConfig(),
+      columns: this.columnsConfig(),
+      server: {
+        url: this.apiUrl(),
+        then: this.dataProcessor(),
+        total: this.totalRecords(),
+      },
+      pagination: this.paginationConfig(),
+      search: this.searchConfig(),
+      sort: this.sortConfig(),
+    });
+
+    grid.render(document.getElementById('gridjs'))
+  }
+
+  languageConfig() {
+    return {
+      search: {
+        placeholder: '🔍 Search...',
+      },
+      // pagination: {
+      //   previous: '⬅️',
+      //   next: '➡️',
+      //   showing: '😃 Displaying',
+      //   results: () => 'Records',
+      // },
+    };
+  }
+
+  columnsConfig() {
+    throw new Error('columnsConfig() must be implemented in the child class.');
+  }
+
+  apiUrl() {
+    throw new Error('apiUrl() must be implemented in the child class.');
+  }
+
+  dataProcessor() {
+    throw new Error('dataProcessor() must be implemented in the child class.');
+  }
+
+  totalRecords() {
+    return (data) => data.total;
+  }
+
+  paginationConfig() {
+    return {
+      enabled: true,
+      limit: 10,
+      server: {
+        url: (prev, page, limit) => {
+          return `${prev}${prev.includes('?') ? '&' : '?'}limit=${limit}&offset=${page * limit}`;
+        },
+      },
+    };
+  }
+
+  sortConfig() {
+    return {
+      enabled: true,
+      multiColumn: false,
+      server: {
+        url: (prev, columns) => {
+          if (!columns.length) return prev;
+
+          const col = columns[0];
+          const dir = col.direction === 1 ? 'asc' : 'desc';
+          const colName = this.columnsConfig()[col.index].toLowerCase();
+
+          // Get the base URL without any query parameters
+          const baseUrl = prev.split('?')[0];
+
+          // Remove existing order and dir parameters
+          const searchParams = new URLSearchParams(prev.split('?')[1] || '');
+          searchParams.delete('order');
+          searchParams.delete('dir');
+
+          // Add new order and dir parameters
+          searchParams.set('order', colName);
+          searchParams.set('dir', dir);
+
+          // Return the modified URL
+          return `${baseUrl}?${searchParams.toString()}`;
+        },
+      },
+    };
+  }
+
+  searchConfig() {
+    return {
+      server: {
+        url: (prev, keyword) => {
+          // Get the base URL without any query parameters
+          const baseUrl = prev.split('?')[0];
+  
+          // Remove existing search parameter
+          const searchParams = new URLSearchParams(prev.split('?')[1] || '');
+          searchParams.delete('search');
+  
+          // Add new search parameter
+          searchParams.set('search', keyword);
+  
+          // Return the modified URL
+          return `${baseUrl}?${searchParams.toString()}`;
+        },
+      },
+    };
+  }  
+}

data/lib/generators/angsa/templates/angsa_stimulus_controller.js

@@ -0,0 +1,31 @@
+import { html } from 'gridjs';
+import AngsaGridjsController from './angsa_gridjs_controller';
+
+export default class <%= stimulus_controller_name %> extends AngsaGridjsController {
+  columnsConfig(){
+    // TODO: Return the appropriate columns for your model
+    return [
+<%= @columns.map { |column| '      \"#{column}\"' }.join(",\n") %>
+    // {
+    //   name: 'Actions', 
+    //   formatter: (_, row) => html(`<a href='${this.apiUrl().replace('.json', '')}/${row.cells[3].data}'><i class='far fa-arrow-alt-circle-right'></></a>`)
+    // },
+    ]
+    
+  }
+
+
+  apiUrl() {
+    // TODO: Return the appropriate API URL for your model
+    return '<%= angsa_api_url %>s.json';
+  }
+
+  dataProcessor() {
+    // TODO: Return the appropriate data processing function for your model
+    return (data) => data.data.map((item) => [
+      <% @columns.each do |column| %>
+      item.<%= column.downcase %>,
+      <% end %>
+    ]);
+  }
+}

data/lib/generators/angsa/templates/table_setup.rb

@@ -0,0 +1,14 @@
+class <%= model_class_name %> < Angsa::Base
+  def initialize(params)
+    super(params, <%= model_name %>)
+  end
+
+  def columns
+    [
+      # TODO: Declare your columns here with the provided params
+      # { name: :id, source: 'id', searchable: false, type: :integer },
+      # { name: :name, source: 'name', searchable: true, type: :string },
+      # { name: :available, source: 'available', searchable: true, type: :boolean },
+    ]
+  end
+end

data/sig/angsa.rbs

@@ -0,0 +1,4 @@
+module Angsa
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: angsa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kennedy Wee
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-29 00:00:00.000000000 Z
+dependencies: []
+description: The Angsa gem is a server-side tool for Ruby on Rails applications that
+  provides pagination, sorting, and search capabilities for ActiveRecord models. It
+  is specifically designed to work with Grid.js, a JavaScript library for table grid
+  layouts.
+email:
+- kennedy@elevateacademy.my
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/angsa.rb
+- lib/angsa/base.rb
+- lib/angsa/pagination.rb
+- lib/angsa/searching.rb
+- lib/angsa/sorting.rb
+- lib/angsa/version.rb
+- lib/generators/angsa/install_generator.rb
+- lib/generators/angsa/js_generator.rb
+- lib/generators/angsa/table_generator.rb
+- lib/generators/angsa/templates/angsa_gridjs_controller.js
+- lib/generators/angsa/templates/angsa_stimulus_controller.js
+- lib/generators/angsa/templates/table_setup.rb
+- sig/angsa.rbs
+homepage: https://github.com/kennedywee/angsa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kennedywee/angsa
+  source_code_uri: https://github.com/kennedywee/angsa
+  changelog_uri: https://github.com/kennedywee/angsa/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: The Angsa gem is a server-side helper for Rails applications, offering pagination,
+  sorting, and search functionalities for ActiveRecord models, tailored for Grid.js,
+  a JavaScript grid library.
+test_files: []