infold 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22d0d58a49eeff5ad6dc7308cdafbe979c97ea38753f3e28b5fc136957b5bd6c
-  data.tar.gz: 02cc7042a7182e2e8dcd744057e64fcd828720011ae4108972ba2b6c5b5a8169
+  metadata.gz: a965cd1508d39abde6e77ad66a19dec7a088159b3562d795576dc70a3a36332a
+  data.tar.gz: 40163f510b91241b30fe97c56dfe9114e679f5de014c2f451b3a00de0e42650b
 SHA512:
-  metadata.gz: 34f264655f92b14dea2e74e99185e6bd75daf41e7ccb2c013d5118465cab7e08b61ebaa7362f7f341b2f300b529c24e978705e3e367e7027bdd4d882edbe7130
-  data.tar.gz: 1c5efe138795d184cf946dc2af5871ec3989ca903ebf47e8495aebacbca77b5849dd77859e933fd5467d295f64db87590dc155e23882102d9c946206eac0f71c
+  metadata.gz: 8c24112c452a48c2fcb3ca34b6cf8ea6a49edf18ecfe61ffd8ca35a972f484449af54cac939c2adfb1cfdd27cb635cbd5f59a4bced5e6a4248a0b647e5c5c4a7
+  data.tar.gz: 6bce2862588f717f633d09f1af464d9668f2a10a7de36f8c72610ab0141e76ec90d57e35b877b4b4ebe9c2789ad389d4efe1340fd523fe19f1e1fc311bb50140

data/README.md

@@ -1,33 +1,431 @@
 # Infold
-[infold](https://infold.dev) (**in**ternal tool + scaf**fold**) is a Ruby Gem that creates admin system like [ActiveAdmin](https://github.com/activeadmin/activeadmin). However, no need to use DSL. Configure from GUI, and it'll automatically generate the code like Scaffold. This code is written in plain Ruby on Rails, easy readable and  customizable.
+Infold provides Scaffolding functionality specifically for Internal tools.
+CRUD (Create, Read, Update, Delete) applications with an easy-to-use UI can be built instantly.
+The generated code is highly readable and customizable, allowing for easy additional customization.
+Supports Rails >= 7.0 and Hotwire.
+
+## Goals
+- Quickly and easily build Internal tools with all the functionality you need
+- No need for a designer, just a developer to create a usable UI/UX
+- Easy customization with YAML and Scaffold instead of DSL development
 
 ## Getting started
-- Check out [the docs](https://docs.infold.dev).
-- Try the [live demo](https://demo.infold.dev).
-- [Website](https://infold.dev)
+- Try the [live demo](https://demo.infold.dev/admin).
+- Check the [website](https://infold.dev).
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'infold', require: false
+```
+
+In addition, infold uses the following Gem, add these lines to your Gemfile too.
+```ruby
+gem 'devise'           # Certification
+gem 'haml-rails'       # HAML
+gem 'kaminari'         # Pagination
+gem 'view_component'   # View Component
+gem 'active_decorator' # Decoration
+gem 'enum_help'        # Enum Helpers
+```
+
+Then run `bundle install`
+
+Next, you need to run the generator:
+```shell
+$ rails generate infold:install
+```
+
+At this point, several common files for CRUD applications are generated.
+
+### Devise Setup
+With the above installation, Devise is also installed. Please migrate for Device user's table.
+```shell
+$ rails db:migrate
+```
+
+Create a test user for Devise from rails console.
+```shell
+$ rails console
+```
+```ruby
+AdminUser.create(email: 'user@example.com', password: 'password')
+```
+
+## Basic Usage
+Specify the target model for CRUD and generate code from the generator.
+The following is an example of a Product model.
+```shell
+$ rails generate infold Product
+```
+
+The above commands will generate several files, including Controller and View.
+You can check it by starting rails from `bin/dev` and accessing `http://localhost:3000/admin`.
+
+![basic](./readme/basic.png)
+
+By executing the above command, each directory, such as controllers, models, and views, automatically generates code to run the internal tools.  
+This mechanism is similar to Rails' Scaffold, and it is possible to implement additional necessary functions based on this.
+
+However, **this is not the only functionality that can generate from Infold**.  
+Let's customize YAML and automatically generate the necessary functions by referring to the following contents.
+
+## More Customization
+Infold can be customized more by configuring YAML. YAML is generated in the `config/infold` directory.
+After setting up YAML, the code is regenerated by executing the following command.
+```shell
+$ rails generate infold:scaffold ResourceName (eg: Product)
+```
+
+### YAML for demo apps
+The YAML file for the [demo apps](https://demo.infold.dev/admin) can be referenced [here](https://github.com/yamataka22/infold/tree/main/test/dummy/config/infold). Please refer to it.
+
+### Validation
+In `model`.`validate`, you can define validation for each field.
+#### Example
+The following example shows the `title` and `price` fields with required validation and the `price` field with numeric and greater than or equal to 0 validation.
+```yaml
+model:
+  validate:
+    title: presence
+    price:
+      - presence
+      - numericality:
+          greater_than_or_equal_to: 0
+```
+Then validation is activated on the form screen.
+
+![validate](./readme/validate.png)
+
+### Enum
+In `model`.`enum`, you can define enum field.
+#### Example
+The following example defines an enum in the `status` field and sets the elements to `ordered`(value: 1), `charged`(value: 2), and `delivered`(value: 3).
+```yaml
+model:
+  enum:
+    status:
+      ordered: 1
+      charged: 2
+      delivered: 3
+```
+
+Then the screen displays the Name of the Enum.
+
+![enum](./readme/enum.png)
+
+#### Colored Enum
+Enum also allows you to specify a color for each element.
+The available colors are `blue`, `azure`, `indigo`, `purple`, `pink`, `red`, `orange`, `yellow`, `lime`, `green`, `teal` and `cyan`.
+#### Example
+```yaml
+model:
+  enum:
+    status:
+      ordered:
+        value: 1
+        color: blue
+      charged:
+        value: 2
+        color: pink
+      delivered:
+        value: 3
+        color: green
+```
+
+It will then be displayed with a colored badge for easy identification.
+
+![colored_enum](./readme/colored_enum.png)
+
+### Decorator
+In `model`.`decorator`, you can define simple decorations such as comma-separated numbers and units.
+#### Example
+In the following example, the `price` field indicates a comma-separated number and "$" as the unit of measure in the front, and the `weight` field indicates "Kg" in the back.
+```yaml
+model:
+  decorator:
+    price:
+      prepend: $
+      digit: true
+    weight:
+      append: Kg
+```
+
+Price indicated as comma-separated and with units.
+
+![decorator](./readme/decorator.png)
+
+### ActiveStorage
+Infold supports ActiveStorage. If you want to store files such as images or PDFs, define them in the `model`. `active_storage`.
+
+**As a prerequisite, ActiveStorage must installed in the project.**
+#### Example
+In the following example, define the use of ActiveStorage with the name `photo` and select "image" as kind (for PDF, etc., select "file" as kind).
+```yaml
+model:
+  active_storage:
+    photo:
+      kind: image
+```
 
-## How it works
-infold consists of two main steps:
+Then images stored in ActiveStorage can be displayed.
 
-1. Configure your admin system on the browser.
-   <div>After installing infold, access http://localhost:3000/infold, you will be able to configure admin system on your browser.</div>
+![active_storage_image](./readme/active_storage_image.png)
 
-2. Generate source code automatically and customize.
-   <div>After configured, infold will automatically generate source code according to your settings. The code is written in plain Ruby on Rails, so easy-to-customize. Feel free to customize your code to suit your needs.</div>
+### Association
+Infold supports an association with other models such as `has_many` and `belongs_to`. By defining `model`.`association`, it is possible to bulk register and reference, related models.
+### belongs_to
+For example, the relation `purchase` belongs_to `customer` is defined as follows:
+```yaml
+model:
+  association:
+    customer:
+      kind: belongs_to
+```
+#### Naming field
+In the case of `belongs_to`, the field representing the record name of the referenced parent model, if any, is defined in `name_filed`.  
+The `customer.name` associated with the `customer_id` is displayed. The `customer` is also displayed as a link, which can be clicked to view the details of the `customer`.
+```yaml
+model:
+  association:
+    customer:
+      kind: belongs_to
+      name_field: name
+```
 
-## Documentation
+![belongs_to](./readme/belongs_to.png)
 
-See [docs.infold.dev](https://docs.infold.dev/) for documentation.
+### has_many, has_one
+For example, the relation `order` has_many `order_details` is defined as follows:
+```yaml
+model:
+  association:
+    order_details:
+      kind: has_many
+      dependent: destroy
+```
+
+The `app.show.fields` settings described below will enable batch registration and referencing of has_many.
+
+#### Batch reference in detail view
+![has_many_show](./readme/has_many_show.png)
+
+#### Advanced configuration of the referenced model in `has_many`.
+For example, in a `has_many` association, such as `order` and `order details`, you may want to register multiple `order details` at once when registering `order`.
+In this case, by defining the `model` in the association model, Validation, Enum, etc., can be defined in the same way as above.
+#### Example
+In the example below, there is a `has_many order_details` association.
+For this `order_details`, define a required validation for the `product_id` field, and a decorator for the `amount` field. It also defines an `association`.`belongs_to` for the `product` with which the `order_detail` is associated with.
+```yaml
+model:
+  association:
+    order_details:
+      kind: has_many
+      model:
+        validate:
+          product: presence
+        decorator:
+          amount:
+            digit: true
+        association:
+          product:
+            kind: belongs_to
+            name_field: title
+```
+
+#### Bulk Registration Form
+In the following example, multiple lines of OrderDetails can be registered at once.  
+You can add rows from the ADD button and delete records with the trash icon.
+
+![has_many_form](./readme/has_many_form.png)
+
+## View Customization
+### Index (list) view
+#### Search conditions
+In `app`.`index`.`conditions`, you can define search condition for the resource.
+The condition specifies `sign` and `form_kind`.
+
+sign can be specified as follows:
+- eq (equal)
+- lteq (less than equal)
+- gteq (gather than equal)
+- full_like (like %...%)
+- start_with (like ...%)
+- any (Used to specify multiple elements of Enum with "or")
+
+form_kind can be specified as follows:
+- text
+- number (input type="number")
+- select
+- switch (Used with the boolean type)
+- association_search (For association columns in belongs_to, `association_search` allows you to search and specify the related tables from the child screen.)
+
+#### Example
+For example, equal search for id, association search for customer_id, and multiple checkboxes for status are defined as follows:
+```yaml
+app:
+  index:
+    conditions:
+      - id:
+          sign: eq
+      - customer_id:
+          sign: eq
+          form_kind: association_search
+      - status:
+          sign: any
+          form_kind: checkbox
+```
+
+![index_condition](./readme/index_condition.png)
+
+#### List
+In `app`.`index`.`list`, you can define which items are displayed in the list and the default sort order (you can change the sort order by clicking on the header cell of the list).  
+If you specify an association name in the list field, the name_field of the associated destination will be displayed in link format.
+#### Example
+```yaml
+app:
+  index:
+    list:
+      fields:
+        - id
+        - customer
+        - status
+        - total_price
+        - delivered_at
+      default_order:
+        field: id
+        kind: desc
+```
+
+![index_view](./readme/index_view.png)
+
+#### CSV output
+Infold also allows CSV output of search results. Define the target columns in `app`.`index`.`csv`.`fields`. If empty, all fields will be output.
+
+#### Example
+```yaml
+app:
+  index:
+    csv:
+      fields:
+        - id
+        - title
+        - price
+        - created_at
+        - updated_at 
+```
+
+### Show (detail) view
+In `app`.`show`.`fields`, you can specify the fields and the order in which they are displayed on the detail screen.  
+If you include has_many / has_one associations in the field, you can also specify fields for the associated destination model.
+
+#### Example
+- The following example shows fields such as `id` and `status` to be displayed.
+- It also displays the `customer.name_field` by including the `customer` in the `belongs_to` association.  
+- In addition, the has_many association `order_details` is included. The `product`, `amount` and `unit_price` of this `order_details` are specified as the display field.
+```yaml
+app:
+  show:
+    fields:
+      - id
+      - customer
+      - status
+      - order_details:
+          fields:
+            - product
+            - amount
+            - unit_price
+      - created_at
+```
+
+![has_many_show](./readme/has_many_show.png)
+
+### Form (Registration and Edit) view
+In `app`.`form`.`fields`, you can define fields for registration and update forms.
+
+Specify the form type from `kind`, `kind` can be specified as follows:
+- text (default)
+- number (input type="number")
+- email (input type="email")
+- password (input type="password")
+- text_area
+- radio
+- select
+- switch (boolean)
+- file (defined in ActiveStorage)
+- association_search (For association columns in belongs_to, `association_search` allows you to search and specify the related tables from the child screen.)
+
+If has_many/has_one of association is specified in the field, batch registration of related models is enabled.
+
+#### Example
+- Able to search and specify the related customer from a child screen (related to `order belongs_to customer`)
+- The `status` allows radio button selection of Enum elements
+- The decorator's append($) set to `total_price` is displayed on the form
+- Enable batch registration of related data, including `order_details`, which are related to has_many.
+    - Display `product_id`, `amount`, `unit_price` from related `order_details` on the form
+    - In relation to `order_detail belongs_to product`, the related product can be searched from the child screen.
+    - ADD button to add rows.
+```yaml
+app:
+  form:
+    fields:
+      - customer:
+          kind: association_search
+      - status:
+          kind: radio
+      - total_price:
+          kind: number
+      - order_details:
+          kind: association
+          fields:
+            - product_id:
+                kind: association_search
+            - amount
+            - unit_price
+```
+
+![form](./readme/form.png)
+
+### Association search view
+Fields related to `belongs_to` can be searched and selected from the child screens for data in the related model.
+
+**Note: Child screen should be defined in the caller's resource (YAML). For example, in the case of `order belongs_to customer`, define the association_search in the YAML of the `customer`, not in the `order`.**
+
+The configuration is the same as for `app`.`index`. Define the necessary fields for `conditions` and `list`.
+#### Example
+- Use `name` and `email` as search criteria
+- list `id`, `name` and `email`.
+```yaml
+app:
+  association_search:
+    conditions:
+      - name:
+          sign: full_like
+      - email:
+          sign: start_with
+    list:
+      fields:
+        - id
+        - name
+        - email
+```
+If a customer is defined as kind=association_search on the Order form, the customer can be searched and selected from the child screens.
+
+![association_search](./readme/association_search.gif)
 
 ## Dependencies
-infold is built with other open source projects:
-- [tabler](https://github.com/tabler/tabler)
-- [devise](https://github.com/heartcombo/devise)
-- [kaminari](https://github.com/kaminari/kaminari)
-- [enum_help](https://github.com/zmbacker/enum_help)
-- [view_component](https://github.com/github/view_component)
-- [active_decorator](https://github.com/amatsuda/active_decorator)
-- [haml-rails](https://github.com/haml/haml-rails)
+Infold is built with other open source projects:
+
+| TOOL                                                             | DESCRIPTION                                                                |
+|------------------------------------------------------------------|----------------------------------------------------------------------------|
+| [tabler](https://github.com/tabler/tabler)                       | HTML Dashboard UI Kit built on Bootstrap                                   |
+| [devise](https://github.com/heartcombo/devise)                   | Flexible authentication solution for Rails with Warden.                    |
+| [kaminari](https://github.com/kaminari/kaminari)                 | Clean, powerful, customizable and sophisticated paginator                  |
+| [enum_help](https://github.com/zmbacker/enum_help)               | Help ActiveRecord::Enum feature to work fine with I18n                     |
+| [view_component](https://github.com/github/view_component)       | A framework for building reusable, testable & encapsulated view components |
+| [active_decorator](https://github.com/amatsuda/active_decorator) | A simple and Rubyish view helper for Rails                                 |
+| [haml-rails](https://github.com/haml/haml-rails)                 | A templating engine for HTML                                               |
+
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,8 +1,3 @@
 require "bundler/setup"
 
-APP_RAKEFILE = File.expand_path("spec/dummy_app/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
-
-load "rails/tasks/statistics.rake"
-
 require "bundler/gem_tasks"

data/lib/generators/infold/controller_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators/base'
+require 'infold/writers/controller_writer'
+require 'infold/resource'
+require 'infold/db_schema'
+require 'infold/yaml_reader'
+
+module Infold
+  class ControllerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def setup
+      resource_name = name.camelize.singularize
+      db_schema_file = Rails.root.join('db/schema.rb')
+      db_schema = DbSchema.new(File.exist?(db_schema_file) ? File.read(db_schema_file) : nil)
+      yaml = YAML.load_file(Rails.root.join("config/infold/#{resource_name.underscore}.yml"))
+      resource = YamlReader.generate_resource(resource_name, yaml, db_schema)
+      @writer = ControllerWriter.new(resource)
+    end
+
+    def create_controller_file
+      template "controller.rb", Rails.root.join("app/controllers/admin/#{name.pluralize.underscore}_controller.rb"), force: true
+    end
+
+    def add_routes
+      file = Rails.root.join('config/routes/admin.rb')
+      route = "resources :#{name.pluralize.underscore}"
+      return unless File.exist?(file)
+      in_file = File.readlines(file).grep(/^\s+#{route}$/)
+      if in_file.blank?
+        inject_into_file file, after: "namespace 'admin' do" do
+          "\n  #{route}"
+        end
+      end
+
+      gsub_file file, "root :to => 'admin_users#index'",
+                "root :to => '#{name.pluralize.underscore}#index'"
+    end
+
+    def add_menu
+      return if name.pluralize.underscore == 'admin_users'
+      file = Rails.root.join('app/views/admin/common/_header_menu.html.haml')
+      return unless File.exist?(file)
+      menu = "\n  %li.nav-item\n    = link_to '#{@writer.resource.app_title}', #{@writer.index_path}, class: 'nav-link'"
+      in_file = File.readlines(file).grep(/, #{@writer.index_path},/)
+      if in_file.blank?
+        append_to_file file do
+          menu
+        end
+      end
+    end
+  end
+end

data/lib/generators/infold/decorator_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/base'
+require 'infold/writers/decorator_writer'
+require 'infold/resource'
+require 'infold/db_schema'
+require 'infold/yaml_reader'
+
+module Infold
+  class DecoratorGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def setup
+      resource_name = name.camelize.singularize
+      db_schema_file = Rails.root.join('db/schema.rb')
+      db_schema = DbSchema.new(File.exist?(db_schema_file) ? File.read(db_schema_file) : nil)
+      yaml = YAML.load_file(Rails.root.join("config/infold/#{resource_name.underscore}.yml"))
+      @resource = YamlReader.generate_resource(resource_name, yaml, db_schema)
+    end
+
+    def create_model_file
+      @writer = DecoratorWriter.new(@resource)
+      template "decorator.rb", Rails.root.join("app/decorators/admin/#{name.underscore.singularize}_decorator.rb"), force: true
+    end
+
+    def create_association_model_file
+      @resource.associations&.
+        select { |as| !as.belongs_to? && as.field_group.has_association_model? }&.each do |association|
+        @writer = DecoratorWriter.new(association)
+        template "decorator.rb", Rails.root.join("app/decorators/admin/#{association.model_name(:snake)}_decorator.rb"), force: true
+      end
+    end
+  end
+end

data/lib/generators/infold/install_generator.rb

@@ -0,0 +1,98 @@
+require 'rails/generators/base'
+
+module Infold
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates/install', __dir__)
+
+    def check_devise_installed
+      initializer_file =
+        File.join(Rails.root, "config", "initializers", "devise.rb")
+      @devise_installed = File.exist?(initializer_file)
+    end
+
+    def install_devise
+      require "devise"
+
+      if @devise_installed
+        log :generate, "No need to install devise, already done."
+      else
+        log :generate, "devise:install"
+        invoke "devise:install"
+      end
+    end
+
+    def create_devise_user
+      invoke "devise", ["admin_User"]
+    end
+
+    def delete_devise_routes
+      routes_file = File.join(destination_root, "config", "routes.rb")
+      gsub_file routes_file, /devise_for :admin_users.*$/, ""
+    end
+
+    def edit_devise_config
+      config_file = File.join(destination_root, "config", "initializers", "devise.rb")
+      gsub_file config_file, /# config.scoped_views = false$/, "config.scoped_views = true"
+      unless @devise_installed
+        gsub_file config_file, /# config.parent_controller = 'DeviseController'$/, "config.parent_controller = 'Admin::TurboDeviseController'"
+        gsub_file config_file, "# config.navigational_formats = ['*/*', :html]", "config.navigational_formats = ['*/*', :html, :turbo_stream]"
+        gsub_file config_file, "# config.warden do |manager|", "config.warden do |manager|\n    manager.failure_app = TurboFailureApp\n  end"
+        code = <<-CODE.gsub(/^\s+/, '')
+          # Turbo doesn't work with devise by default.
+          # Keep tabs on https://github.com/heartcombo/devise/issues/5446 for a possible fix
+          # Fix from https://gorails.com/episodes/devise-hotwire-turbo
+          class TurboFailureApp < Devise::FailureApp
+          [TAB]def respond
+          [TAB][TAB]if request_format == :turbo_stream
+          [TAB][TAB][TAB]redirect
+          [TAB][TAB]else
+          [TAB][TAB][TAB]super
+          [TAB][TAB]end
+          [TAB]end
+          
+          [TAB]def skip_format?
+          [TAB][TAB]%w(html turbo_stream */*).include? request_format.to_s
+          [TAB]end
+          end
+        CODE
+        inject_into_file(config_file, before: "Devise.setup do |config|") { code.gsub('[TAB]', '  ') }
+      end
+    end
+
+    def copy_app_files
+      template_path = File.expand_path("templates/install", __dir__)
+      Dir.glob("#{template_path}/app/**/*").each do |item|
+        next if FileTest.directory?(item) || item.end_with?('admin.scss')
+        dist_path = item.to_s.gsub(template_path.to_s, Rails.root.to_s)
+        template item, dist_path, encoding: :utf8, ask: true
+      end
+    end
+
+    def edit_routes_file
+      template "config/routes/admin.rb", "config/routes/admin.rb", ask: true
+      route "draw(:admin)"
+    end
+
+    def copy_locale_files
+      template_path = File.expand_path("templates/install/config/locales", __dir__)
+      Dir.glob("#{template_path}/*") do |item|
+        dist_path = Rails.root.join("config/locales", item.split('/').last)
+        template item, dist_path, encoding: :utf8, ask: true
+      end
+    end
+
+    def install_admin_users
+      template "config/infold/admin_user.yml", "config/infold/admin_user.yml", ask: true
+      generate 'infold:scaffold', 'admin_user'
+
+      route_file = Rails.root.join('config/routes/admin.rb')
+      route = "resources :admin_users"
+      in_file = File.readlines(route_file).grep(/^\s+#{route}$/)
+      if in_file.blank?
+        inject_into_file route_file, after: "namespace 'admin' do" do
+          "\n  #{route}"
+        end
+      end
+    end
+  end
+end