warped 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967b7e175b3e607946af10eef1af2cd6400d8bcb294a7a49a3298568b6234b25
-  data.tar.gz: f959ca8e38e009e9a59daecab21fb4ae855e2f3ad516a660b69c29c6acb219f3
+  metadata.gz: 01d84d855e451182cddf0b6d9e38d922e0dfd40c5ee05752496759d5344b042b
+  data.tar.gz: 9d0ddb61f7af15597abb5e0a12f11cbb602f86b2f52763288f4be797f2d41509
 SHA512:
-  metadata.gz: 5665f91cf7cb50151006cf7852283c4a5da5e05506a039eb70a8464738fee9b1c7903f530e1301489a9788f5781ef10e095efdd4acd19fe7e9fa253845b6beec
-  data.tar.gz: b6c2c71ab7de2ac911d599135a166a00e5a62870be1182c445f994656186d4f7fabf156fd6c513b5699ca3747ba9cd4351560b2441703ceca0576059ae4cf8f0
+  metadata.gz: 4b9d8acfdfd217f5755800657688ce6e2c5f7ddab564a8b658c6a94ee38d8b19ae1dc5f416ea3996d103015cf09793734beeaa63b1388356347b5354eb65da10
+  data.tar.gz: '0407936f782cdc2dbb0f210b43a7204a6758866e13bd1eb6772b3410e7063f49909dc3ed60d3cfd081ece0dfdccc10a6ced6e4f295d407f4795ea9f4bbe00b85'

data/.rubocop.yml

@@ -18,13 +18,32 @@ Layout/LineLength:
   Exclude:
     - "lib/warped/queries/paginate.rb"
 
+Metrics/AbcSize:
+  Exclude:
+    - "lib/warped/controllers/filterable/ui.rb"
+    - "lib/warped/controllers/sortable/ui.rb"
+    - "lib/warped/emails/components/**/*.rb"
+    - "lib/warped/queries/filter.rb"
+
 Metrics/BlockLength:
   Exclude:
+    - "lib/warped/emails/components/**/*.rb"
     - "spec/**/*"
 
+Metrics/ParameterLists:
+  Exclude:
+    - "lib/warped/emails/components/**/*.rb"
+
 Metrics/CyclomaticComplexity:
   Exclude:
     - "lib/warped/queries/filter.rb"
 
 Metrics/MethodLength:
   Max: 20
+  Exclude:
+    - lib/warped/queries/filter.rb
+
+Style/OptionalArguments:
+  Exclude:
+    - lib/warped/emails/components/button.rb
+    - lib/warped/emails/components/link.rb

data/Gemfile

@@ -10,5 +10,3 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
-
-gem "debug", "~> 1.5", platforms: %i[mri mingw x64_mingw]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    warped (0.1.0)
+    warped (0.2.0)
       rails (>= 6.0, < 8.0)
       zeitwerk (>= 2.4)
 
@@ -90,12 +90,8 @@ GEM
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
-    debug (1.9.1)
-      irb (~> 1.10)
-      reline (>= 0.3.8)
     diff-lcs (1.5.1)
-    drb (2.2.0)
-      ruby2_keywords
+    drb (2.2.1)
     erubi (1.12.0)
     globalid (1.2.1)
       activesupport (>= 6.1)
@@ -115,7 +111,7 @@ GEM
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.2)
+    marcel (1.0.4)
     mini_mime (1.1.5)
     minitest (5.22.2)
     mutex_m (0.2.0)
@@ -129,8 +125,18 @@ GEM
     net-smtp (0.4.0.1)
       net-protocol
     nio4r (2.7.0)
+    nokogiri (1.16.2-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.2-arm-linux)
+      racc (~> 1.4)
     nokogiri (1.16.2-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.16.2-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.2-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
@@ -180,7 +186,7 @@ GEM
     rdoc (6.6.2)
       psych (>= 4.0.0)
     regexp_parser (2.9.0)
-    reline (0.4.2)
+    reline (0.4.3)
       io-console (~> 0.5)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -196,7 +202,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.60.2)
+    rubocop (1.61.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -207,12 +213,11 @@ GEM
       rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.1)
+      parser (>= 3.3.0.4)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     stringio (3.1.0)
-    thor (1.3.0)
+    thor (1.3.1)
     timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -224,17 +229,18 @@ GEM
     zeitwerk (2.6.13)
 
 PLATFORMS
-  arm64-darwin-21
-  arm64-darwin-22
-  arm64-darwin-23
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
   x86_64-linux
 
 DEPENDENCIES
-  debug (~> 1.5)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   warped!
 
 BUNDLED WITH
-   2.3.26
+   2.5.6

data/README.md

@@ -7,7 +7,7 @@ Develop rails applications at the speed of thought. Warped is a collection of to
 
 Install the gem and add to the Rails application's Gemfile by executing:
 
-    $ bundle add warped-rails
+    $ bundle add warped
 
 Then run the generator to create the configuration file:
 
@@ -57,95 +57,7 @@ GET /users?email=john@example.com
 GET /users?created_at=2021-01-01
 ```
 
-##### Referencing tables in the filterable fields
-
-The `filterable_by` method can also be used to reference fields in associated tables. For example, to filter the users by the name of the company they work for, the following can be done:
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Filterable
-
-  filterable_by :name, :email, :created_at, 'companies.name'
-
-  def index
-    users = filter(User.joins(:company))
-    render json: users
-  end
-end
-```
-
-Request examples:
-```
-GET /users?name=John
-GET /users?companies.name=Acme
-```
-
-##### Renaming the filter query parameters
-
-If you don't want to use the field name as the query parameter (as to not expose the database schema, or when joining the same table multiple times),
-you can specify the query parameter to use for each field:
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Filterable
-
-  filterable_by 'companies.name' => :company_name, 'users.name' => :user_name
-
-  def index
-    users = filter(User.join(:company))
-    render json: users
-  end
-end
-```
-
-Request examples:
-```
-GET /users?user_name=John
-GET /users?company_name=Acme
-```
-
-##### Using filters other than `eq`
-
-By default, the `filter` method will use the `eq` filter method to filter the records. If you want to use a different filter method, you can specify the filter "relation" in the query parameter:
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Filterable
-
-  filterable_by :name, :age
-
-  def index
-    users = filter(User.all)
-    render json: users
-  end
-end
-```
-
-Request examples:
-```
-GET /users?name=John # returns users with name John
-GET /users?name[]=John&name[]=Jane # returns users where the name is in ('John', 'Jane')
-GET /users?age.rel=is_null # returns users where the age is null
-GET /users?age.rel=is_not_null # returns users where the age is not null
-GET /users?age.rel=between&age[]=18&age[]=30 # returns users with age between 18 and 30
-GET /users?age.rel=%3E%0A&age=18 # returns users with age greater than 18, %3E%0A is url encoded for ">"
-```
-
-The full list of filter relations is:
-- `=` (default) - equals
-- `!=` - not equals
-- `>` - greater than
-- `>=` - greater than or equals
-- `<` - less than
-- `<=` - less than or equals
-- `between` - between (requires two values)
-- `in` - in (default when multiple values are provided)
-- `not_in` - not in (requires multiple values)
-- `starts_with` - starts with
-- `ends_with` - ends with
-- `contains` - contains
-- `is_null` - is null (does not require a value)
-- `is_not_null` - is not null (does not require a  value)
+[Complete documentation for Warped::Controllers::Filterable](docs/controllers/FILTERABLE.md).
 
 #### Warped::Controllers::Searchable
 
@@ -181,67 +93,7 @@ GET /users?q=John
 # calls #search(User.all, search_term: 'John', model_search_scope: :search) in the controller
 ```
 
-##### Customizing the search query parameter
-
-You can customize the default query parameter by:
-1. Passing fetching the fetch term from the params hash, and passing it directly to the search method:
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Searchable
-
-  def index
-    # This will use the query parameter `term` instead of `q`
-    users = search(User.all, search_term: params[:term])
-    render json: users
-  end
-end
-```
-
-2. Overriding the `search_param` method in the controller
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Searchable
-
-  def index
-    # This will use the query parameter `term` instead of `q`
-    users = search(User.all)
-    render json: users
-  end
-
-  private
-
-  def search_param
-    :term
-  end
-end
-```
-
-3. Calling #searchable_by in the controller and overriding the default query parameter
-
-```ruby
-# app/models/user.rb
-class User < ApplicationRecord
-  include PgSearch::Model
-  pg_search_scope :search_by_word, against: :name, using: { tsearch: { any_word: true } }
-end
-
-
-# app/controllers/users_controller.rb
-class UsersController < ApplicationController
-  include Warped::Controllers::Searchable
-
-  # This will use the query parameter `term` instead of `q`
-  # and the search scope `search_by_word` instead of the default
-  searchable_by :search_by_word, param: :term
-
-  def index
-    users = search(User.all)
-    render json: users
-  end
-end
-```
+[Complete documentation for Warped::Controllers::Searchable](docs/controllers/SEARCHABLE.md).
 
 #### Warped::Controllers::Sortable
 
@@ -291,52 +143,8 @@ Request examples:
 ```
 GET /users # sort by id in descending order
 ```
-##### Referencing tables in the sortable fields
 
-Like the `filterable_by` method, the `sortable_by` method can also be used to reference fields in associated tables.
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Sortable
-
-  sortable_by :name, 'companies.name'
-
-  def index
-    users = sort(User.joins(:company))
-    render json: users
-  end
-end
-```
-
-Request examples:
-```
-GET /users?sort_key=name # sort by name in descending order
-GET /users?sort_key=companies.name&sort_direction=asc # sort by company name in ascending order
-```
-
-##### Renaming the sort query parameters
-
-If you don't want to use the field name as the query parameter (as to not expose the database schema, or when joining the same table multiple times),
-you can specify the query parameter to use for each field:
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Sortable
-
-  sortable_by 'companies.name' => :company_name, 'users.name' => :user_name
-
-  def index
-    users = sort(User.join(:company))
-    render json: users
-  end
-end
-```
-
-Request examples:
-```
-GET /users?sort_key=user_name # sort by name in descending order
-GET /users?sort_key=company_name&sort_direction=asc # sort by company name in ascending order
-```
+[Complete documentation for Warped::Controllers::Sortable](docs/controllers/SORTABLE.md).
 
 #### Warped::Controllers::Pageable
 
@@ -351,7 +159,7 @@ class UsersController < ApplicationController
 
   def index
     users = paginate(User.all)
-    render json: users, meta: page_info
+    render json: users, meta: pagination
   end
 end
 ```
@@ -363,51 +171,7 @@ GET /users?per_page=25 # returns the first page of users with 25 records per pag
 GET /users?page=2&per_page=25 # returns the second page of users with 25 records per page
 ```
 
-##### Accessing the pagination information
-
-The `page_info` method can be used to access the pagination information.
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Pageable
-
-  def index
-    users = paginate(User.all)
-    render json: users, meta: page_info
-  end
-end
-```
-
-`page_info` returns a hash with
-- `page` - the current page
-- `per_page` - the number of records per page
-- `total_pages` - the total number of pages
-- `total_count` - the number of records in the scope
-- `next-page` - the next page number
-- `prev-page` - the previous page number
-
-
-##### Customizing the pagination behavior
-
-By default, the `paginate` method will paginate the scope in pages of size 10, and will return the first page if the `page` query parameter is not provided.
-
-Additionally, there's a limit of `100` records per page. So, if the `per_page` query parameter is greater than `100`, the pagination will use `100` as the page size.
-
-You can customize the default page size and the default page number by overriding the `default_per_page` value in the controller.
-
-```ruby
-class UsersController < ApplicationController
-  include Warped::Controllers::Pageable
-
-  # This will set the default page size to 25 when the `per_page` query parameter is not provided
-  self.default_per_page = 25
-
-  def index
-    users = paginate(User.all)
-    render json: users, meta: page_info
-  end
-end
-```
+[Complete documentation for Warped::Controllers::Pageable](docs/controllers/PAGEABLE.md).
 
 #### Warped::Controllers::Tabulatable
 
@@ -425,7 +189,7 @@ class UsersController < ApplicationController
 
   def index
     users = tabulate(User.all)
-    render json: users, meta: page_info
+    render json: users, meta: pagination
   end
 end
 ```
@@ -436,7 +200,9 @@ GET /users?age[]=18&age[]=30&age.rel=between&sort_key=name&sort_direction=asc&q=
 # returns the second page of users with 10 records per page, where the age is between 18 and 30, sorted by name in ascending order, and searched by the term John
 ```
 
-Just like `paginate`, when calling the `tabulate` method in the controller action, the `page_info` method can be used to access the pagination information.
+Just like `paginate`, when calling the `tabulate` method in the controller action, the `pagination` method can be used to access the pagination information.
+
+[Complete documentation for Warped::Controllers::Tabulatable](docs/controllers/TABULATABLE.md).
 
 ### Services
 
@@ -492,33 +258,7 @@ PrintService.call # Executes new.call, prints "Hello, John!"
 PrintService.call('world') # Executes new('world').call, prints "Hello, world!"
 ```
 
-##### Using services as job classes in the background
-
-The `Warped::Service::Base` class provides a class method `.enable_job!` that can be used to enable the service to be used as a job class.
-
-```ruby
-class PrintService < Warped::Service::Base
-  enable_job!
-
-  def call
-    puts 'Hello, world!'
-  end
-end
-```
-
-The `enable_job!` method will define a `PrintService::Job` class that inherits from `Warped::Jobs::Base` and calls the `call` method on the service instance.
-
-```ruby
-PrintService.call_later # Executes PrintService::Job.perform_later
-PrintService::Job.perform_later # Executes PrintService.new.call in the background
-```
-
-call_later and perform_later will pass the arguments to the `initialize` method of the service class, and then call the `call` method on the new instance.
-
-```ruby
-PrintService.call_later('world') # Executes PrintService::Job.perform_later('world')
-PrintService::Job.perform_later('world') # Executes PrintService.new('world').call in the background
-```
+[Complete documentation for Warped::Services](docs/services/README.md).
 
 ### Jobs
 
@@ -543,6 +283,8 @@ Warped.configure do |config|
 end
 ```
 
+[Complete documentation for Warped::Jobs](docs/jobs/README.md).
+
 
 ## Development
 

data/docs/controllers/FILTERABLE.md

@@ -0,0 +1,114 @@
+# Warped::Controllers::Filterable
+
+The `Filterable` concern provides a method to filter the records in a controller's action.
+The method `filterable_by` is used to define the filterable fields and the filter method to use.
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Filterable
+
+  filterable_by :name, :email, :created_at
+
+  def index
+    users = filter(User.all)
+    render json: users
+  end
+end
+```
+The `filter` method will use the query parameters to filter the records. For example, to filter the users by name, email, and created_at, the following query parameters can be used:
+
+```
+GET /users?name=John
+GET /users?email=john@example.com
+GET /users?created_at=2021-01-01
+```
+
+## Referencing tables in the filterable fields
+
+The `filterable_by` method can also be used to reference fields in associated tables. For example, to filter the users by the name of the company they work for, the following can be done:
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Filterable
+
+  filterable_by :name, :email, :created_at, 'companies.name'
+
+  def index
+    users = filter(User.joins(:company))
+    render json: users
+  end
+end
+```
+
+Request examples:
+```
+GET /users?name=John
+GET /users?companies.name=Acme
+```
+
+## Renaming the filter query parameters
+
+If you don't want to use the field name as the query parameter (as to not expose the database schema, or when joining the same table multiple times),
+you can specify the query parameter to use for each field:
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Filterable
+
+  filterable_by 'companies.name' => :company_name, 'users.name' => :user_name
+
+  def index
+    users = filter(User.join(:company))
+    render json: users
+  end
+end
+```
+
+Request examples:
+```
+GET /users?user_name=John
+GET /users?company_name=Acme
+```
+
+## Using filters other than `eq`
+
+By default, the `filter` method will use the `eq` filter method to filter the records. If you want to use a different filter method, you can specify the filter "relation" in the query parameter:
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Filterable
+
+  filterable_by :name, :age
+
+  def index
+    users = filter(User.all)
+    render json: users
+  end
+end
+```
+
+Request examples:
+```
+GET /users?name=John # returns users with name John
+GET /users?name[]=John&name[]=Jane # returns users where the name is in ('John', 'Jane')
+GET /users?age.rel=is_null # returns users where the age is null
+GET /users?age.rel=is_not_null # returns users where the age is not null
+GET /users?age.rel=between&age[]=18&age[]=30 # returns users with age between 18 and 30
+GET /users?age.rel=gt&age=18 # returns users with age greater than 18
+```
+
+The full list of filter relations is:
+- `eq` (default) - equals
+- `neq` - not equals
+- `gt` - greater than
+- `gte` - greater than or equals
+- `lt` - less than
+- `lte` - less than or equals
+- `between` - between (requires two values)
+- `in` - in (default when multiple values are provided)
+- `not_in` - not in (requires multiple values)
+- `starts_with` - starts with
+- `ends_with` - ends with
+- `contains` - contains
+- `is_null` - is null (does not require a value)
+- `is_not_null` - is not null (does not require a  value)

data/docs/controllers/PAGEABLE.md

@@ -0,0 +1,70 @@
+# Warped::Controllers::Pageable
+
+The `Pageable` concern provides a method to paginate the records in a controller's action.
+
+The method `paginate` is used to paginate the records.
+It will use the query parameters `page` and `per_page` to paginate the records.
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Pageable
+
+  def index
+    users = paginate(User.all)
+    render json: users, meta: pagination
+  end
+end
+```
+
+Request examples:
+```
+GET /users?page=1&per_page=10 # returns the first page of users with 10 records per page
+GET /users?per_page=25 # returns the first page of users with 25 records per page
+GET /users?page=2&per_page=25 # returns the second page of users with 25 records per page
+```
+
+## Accessing the pagination information
+
+The `pagination` method can be used to access the pagination information.
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Pageable
+
+  def index
+    users = paginate(User.all)
+    render json: users, meta: pagination
+  end
+end
+```
+
+`pagination` returns a hash with
+- `page` - the current page
+- `per_page` - the number of records per page
+- `total_pages` - the total number of pages
+- `total_count` - the number of records in the scope
+- `next-page` - the next page number
+- `prev-page` - the previous page number
+
+
+## Customizing the pagination behavior
+
+By default, the `paginate` method will paginate the scope in pages of size 10, and will return the first page if the `page` query parameter is not provided.
+
+Additionally, there's a limit of `100` records per page. So, if the `per_page` query parameter is greater than `100`, the pagination will use `100` as the page size.
+
+You can customize the default page size and the default page number by overriding the `default_per_page` value in the controller.
+
+```ruby
+class UsersController < ApplicationController
+  include Warped::Controllers::Pageable
+
+  # This will set the default page size to 25 when the `per_page` query parameter is not provided
+  self.default_per_page = 25
+
+  def index
+    users = paginate(User.all)
+    render json: users, meta: pagination
+  end
+end
+```

data/docs/controllers/README.md

@@ -0,0 +1,8 @@
+# Warped::Controllers
+
+The `Warped::Controllers` module defines five concerns that can be included in a controller to provide additional functionality:
+- [Warped::Controllers::Filterable](FILTERABLE.md)
+- [Warped::Controllers::Searchable](SEARCHABLE.md)
+- [Warped::Controllers::Sortable](SORTABLE.md)
+- [Warped::Controllers::Pageable](PAGEABLE.md)
+- [Warped::Controllers::Tabulatable](TABULATABLE.md)