angsa 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b7ac88bfda0d089508dedc70127219c25598afa1f987f08e724fc6bdcbd2320
-  data.tar.gz: 47bb55cb83f05d9a991f6e2437f60dec4c103ebfbc591187a152dabf194017c4
+  metadata.gz: a45fad18d0808f91ff45aa6745e6409503693a523ff7b92ea97b78d3c1630f06
+  data.tar.gz: 90ecfe981aa19f4a738845a0c788b2a3eca2f2810e4985f379af34bfce6958bb
 SHA512:
-  metadata.gz: 720ec9bf7509e0354722fb46a22df70f6ed1171544f4b2253363479effd43f936399fa2e831fd20ec86ca3df9b966e561fd89c5a55d6e62677c01cd08b716067
-  data.tar.gz: 56b9368d85618471312599f2ffb215327a1214953b6c7b0ade745667fcd4cb4e865eed516de2ceab07bb917589d0b4470c093bb70ba360d016d9f93c03558a3b
+  metadata.gz: 73ff6ed9f04de20632201c142692fc0c2007d3102c367ede3734b34b987fd63c01b3694d2cab69c0da0ad3f4cf18791bda1a771d4db3585119df0c3df6a0ecbe
+  data.tar.gz: 33306732ce13e3002e852b1127062ab062e42c3181ca485250c25b588995e1230222b3ca7ad1d1351cdef8252dcb89c7830664ef915e5396b55a04ce75c3f139

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    angsa (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  angsa!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.26

data/README.md

@@ -1,37 +1,101 @@
+
 # 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.
+Angsa is a comprehensive server-side Ruby gem designed for Ruby on Rails applications. It delivers essential functionalities including pagination, sorting, and search capabilities for ActiveRecord models. The design of Angsa is catered to align smoothly with Grid.js, a powerful JavaScript library engineered for table grid layouts.
+
+## Prerequisites
+
+For Angsa to function properly, it requires specific versions of various software. It has been tested with:
+
+1.  Grid.js
+2.  Rails 7
+3.  Importmap
+4.  Ruby 3.1.3
 
-TODO: Delete this and the text above, and describe your gem
+Please ensure that your environment meets these prerequisites.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+### Step 1: Install Grid.js with Importmap
+
+To get started, install Grid.js by following the instructions provided on the official Grid.js website. Alternatively, you can add Grid.js to your Rails project by executing the following command:
+
+`bin/importmap pin gridjs` 
+
+Next, apply the basic styling for Grid.js available from the official website. Ensure that Grid.js is added to your `javascript/application.js`:
 
-    $ bundle add angsa
+`import 'gridjs'` 
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Step 2: Install Angsa
 
-    $ gem install angsa
+Add the Angsa gem to your application's Gemfile:
+
+`gem "angsa", "~> 0.1.1"` 
+
+To install the gem, execute:
+
+`bundle install` 
 
 ## Usage
+### Generators
+Begin by installing the base JavaScript for Grid.js using the command:
+
+`rails generate angsa:install` 
+
+Next, generate a setup for a model in your project using the command:
+
+`rails generate angsa:table YourModel` 
+
+For instance, if you have a `Post` model, the command will be:
+
+`rails generate angsa:table Post` 
+
+Having declared the required columns, proceed to generate the Stimulus controller with:
+
+`rails generate angsa:js YourModel` 
+
+For example, for the `Post` model, it will be:
+
+`rails generate angsa:js Post` 
+
+
+### Configuring the API URL
+
+The API URL acts as a data source for Grid.js. To generate this URL, include the following code in your target controller. This will facilitate fetching data in JSON format:
+
+```ruby
+respond_to do |format|
+	format.html
+	format.json { render json:  YourModelAngsa.new(params) }
+end
+```
+
+Replace `YourModel` with the name of the model you are working with. For example, for a `Post` model, the line would read `PostAngsa.new(params)`.
+
+### Integrating with Your Views
+
+The subsequent step is to implement the functionality in your views. Here's an example using Slim syntax. Simply append the attributes illustrated below to your table. Grid.js and Angsa will handle the rest:
+
+```ruby
+table#gridjs  data-controller='your-model-angsa'
+``` 
 
-TODO: Write usage instructions here
+Replace `'your-model'` with the name of your model. Remember to use hyphen-case (lowercase with hyphens separating words). For a `Post` model, the line would read `data-controller='post-angsa'`.
 
 ## 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.
+Clone the repository and execute `bin/setup` to install dependencies. Use `bin/console` for an interactive session 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).
+To install this gem locally, use `bundle exec rake install`. If you wish to release a new version, modify the version number in `version.rb`, and execute `bundle exec rake release`. This command creates a git tag for the version, pushes git commits and the created tag, and finally pushes 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).
+We welcome bug reports and pull requests on [GitHub](https://github.com/kennedywee/angsa). We are committed to fostering an environment of collaboration. All contributors are expected to adhere to our [code of conduct](https://github.com/kennedywee/angsa/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Angsa is open-source, licensed under 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).
+We expect everyone interacting in the Angsa project's codebases, issue trackers, chat rooms, and mailing lists to adhere to our [code of conduct](https://github.com/kennedywee/angsa/blob/master/CODE_OF_CONDUCT.md).

data/lib/angsa/version.rb

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

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

@@ -1,14 +1,15 @@
 import { html } from 'gridjs';
-import AngsaGridjsController from './angsa_gridjs_controller';
+import AngsaGridjsController from 'controllers/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") %>
+<%= @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>`)
+    //   sort: false,
+    //   formatter: (_, row) => html(`<a href='${this.apiUrl().replace('.json', '')}/${row.cells[<%= @columns.size - 1 %>].data}'><i class='far fa-arrow-alt-circle-right'></></a>`)
     // },
     ]
     

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

@@ -9,6 +9,10 @@ class <%= model_class_name %> < Angsa::Base
       # { name: :id, source: 'id', searchable: false, type: :integer },
       # { name: :name, source: 'name', searchable: true, type: :string },
       # { name: :available, source: 'available', searchable: true, type: :boolean },
+
+      # Actions: Important! Declare either id or slug
+      # { name: :id, source: 'id', searchable: false, type: :integer },
+      # { name: :slug, source: 'slug', searchable: false, type: :integer },
     ]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: angsa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kennedy Wee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2023-06-09 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
@@ -23,9 +23,12 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- angsa-0.1.0.gem
+- angsa-0.1.1.gem
 - lib/angsa.rb
 - lib/angsa/base.rb
 - lib/angsa/pagination.rb