hmvc-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4dd3f8480d396c51dc8d60cc16c5df9596f66d246079db510e41847f8cc10140
+  data.tar.gz: 6318242634c8b11060724147d7b28f0e7dbecce9338e08a18c5dd041784ad515
+SHA512:
+  metadata.gz: c905bd1b4a55b56c4c0265e21f4d4dfed4526a3d07d571c414475291f3f51ef105ba6c756860212924e3516ce076023449607f8be4846613d401060f1a80e94a
+  data.tar.gz: be42b1a104ff76ac32fbb8b12e21862094f64fab70b88f5a5915fffb78baf74fc25716d0fb865ef4b6aed9b4afadaf8d370511600f8c74170556777680857b09

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-02-15
+
+- 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 thuc.phan@tomosia.com. 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,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hmvc-rails.gemspec
+gemspec
+
+group :test do
+  # Ruby on Rails is a full-stack web framework optimized for programmer happiness and sustainable productivity
+  gem "rails", "7.0"
+
+  # Rake is a Make-like program implemented in Ruby
+  gem "rake", "13.0"
+
+  # RuboCop is a Ruby code style checking and code formatting tool
+  gem "rubocop", "1.21"
+
+  # Minitest provides a complete suite of testing facilities supporting TDD, BDD, mocking, and benchmarking
+  gem "minitest", "5.17"
+end

data/Gemfile.lock

@@ -0,0 +1,172 @@
+PATH
+  remote: .
+  specs:
+    hmvc-rails (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.0)
+      actionpack (= 7.0.0)
+      activesupport (= 7.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.0)
+      actionpack (= 7.0.0)
+      activejob (= 7.0.0)
+      activerecord (= 7.0.0)
+      activestorage (= 7.0.0)
+      activesupport (= 7.0.0)
+      mail (>= 2.7.1)
+    actionmailer (7.0.0)
+      actionpack (= 7.0.0)
+      actionview (= 7.0.0)
+      activejob (= 7.0.0)
+      activesupport (= 7.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.0)
+      actionview (= 7.0.0)
+      activesupport (= 7.0.0)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.0)
+      actionpack (= 7.0.0)
+      activerecord (= 7.0.0)
+      activestorage (= 7.0.0)
+      activesupport (= 7.0.0)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.0)
+      activesupport (= 7.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.0)
+      activesupport (= 7.0.0)
+      globalid (>= 0.3.6)
+    activemodel (7.0.0)
+      activesupport (= 7.0.0)
+    activerecord (7.0.0)
+      activemodel (= 7.0.0)
+      activesupport (= 7.0.0)
+    activestorage (7.0.0)
+      actionpack (= 7.0.0)
+      activejob (= 7.0.0)
+      activerecord (= 7.0.0)
+      activesupport (= 7.0.0)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.0)
+    crass (1.0.6)
+    date (3.3.3)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.19.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.14.2-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.6.2)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.0)
+      actioncable (= 7.0.0)
+      actionmailbox (= 7.0.0)
+      actionmailer (= 7.0.0)
+      actionpack (= 7.0.0)
+      actiontext (= 7.0.0)
+      actionview (= 7.0.0)
+      activejob (= 7.0.0)
+      activemodel (= 7.0.0)
+      activerecord (= 7.0.0)
+      activestorage (= 7.0.0)
+      activesupport (= 7.0.0)
+      bundler (>= 1.15.0)
+      railties (= 7.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.0)
+      actionpack (= 7.0.0)
+      activesupport (= 7.0.0)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.0)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  hmvc-rails!
+  minitest (= 5.17)
+  rails (= 7.0)
+  rake (= 13.0)
+  rubocop (= 1.21)
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 thucpt
+
+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,302 @@
+# HMVC-RAILS
+
+## Summary
+
+- hmvc-rails is the high-level model of MVC (MVC high-level structure)
+
+- hmvc-rails makes it easy to manage source code and develop projects
+
+## Features
+
+- Generate controller file
+- Generate operations file
+- Generate forms file
+- Generate views file
+- Add file creator and creation date
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+group :development do
+  gem 'hmvc-rails', git: 'git@github.com:TOMOSIA-VIETNAM/hmvc-rails.git'
+end
+```
+
+Then execute
+
+```
+bundle install
+```
+
+And run
+
+```
+rails g hmvc_rails:install
+```
+
+```
+create  config/initializers/hmvc.rb
+create  app/operations/application_operation.rb
+create  app/forms/application_form.rb
+create  app/validators/uniqueness_validator.rb
+create  app/validators/email_validator.rb
+```
+
+If it's an API project then you can run
+
+```
+rails g hmvc_rails:install --api
+```
+
+```
+create  config/initializers/hmvc_rails.rb
+create  app/operations/application_operation.rb
+create  app/forms/application_form.rb
+create  app/validators/uniqueness_validator.rb
+create  app/validators/email_validator.rb
+create  lib/hmvc_rails/extras/exception.rb
+create  lib/hmvc_rails/extras/error_resource.rb
+create  lib/hmvc_rails/extras/error_response.rb
+insert  config/application.rb
+insert  app/controllers/application_controller.rb
+```
+
+## Usage
+
+### Default generator
+
+```
+rails g hmvc_rails controller_name
+```
+
+Example
+
+```
+rails g hmvc_rails admin
+```
+
+```
+create  app/controllers/admin_controller.rb
+create  app/operations/admin/index_operation.rb
+create  app/operations/admin/show_operation.rb
+create  app/operations/admin/new_operation.rb
+create  app/operations/admin/create_operation.rb
+create  app/operations/admin/edit_operation.rb
+create  app/operations/admin/update_operation.rb
+create  app/operations/admin/destroy_operation.rb
+create  app/forms/admin/new_form.rb
+create  app/forms/admin/create_form.rb
+create  app/forms/admin/edit_form.rb
+create  app/forms/admin/update_form.rb
+create  app/views/admin/index.html.erb
+create  app/views/admin/show.html.erb
+create  app/views/admin/new.html.erb
+create  app/views/admin/edit.html.erb
+```
+
+### Options
+
+##### 1. If you want to create with action other than default. You can use option `--action`
+
+```
+rails g hmvc_rails admin --action index show list detail selection
+```
+
+##### 2. If you want to create with form action other than default. You can use option `--form`
+
+```
+rails g hmvc_rails admin --action index show list detail selection --form index show list
+```
+
+##### 3. If you want to create with parent controller other than default. You can use option `--parent-controller`
+
+```
+rails g hmvc_rails admin --parent-controller PersonController
+```
+
+##### 4. If you want to skip creating the forms file when generate. You can use option `--skip-form`
+
+```
+rails g hmvc_rails admin --skip-form
+```
+
+Or change configuration `config.form = %w[]`
+
+##### 5. If you want to skip creating the views file when generate. You can use option `--skip-view`
+
+```
+rails g hmvc_rails admin --skip-view
+```
+
+Or change configuration `config.view = %w[]`
+
+## Configuration
+
+If you want to change the default value when creating the file, please uncomment and update
+
+_config/initializers/hmvc.rb_
+
+```ruby
+# frozen_string_literal: true
+
+# Created at: 2023-02-18 22:30 +0700
+# Creator: thuc.phan@tomosia.com
+
+if Rails.env.development?
+  Hmvc::Rails.configure do |config|
+    # The controller files's parent class of controller. Default is ApplicationController
+    # config.parent_controller = "ApplicationController"
+
+    # Method when creating the controller files. Default is %w[index show new create edit update destroy]
+    # config.action = %w[index show new create edit update destroy]
+
+    # Method when creating the view files. Default is %w[index show new edit]
+    # config.view = %w[index show new edit]
+
+    # The form files's parent class. Default is ApplicationForm
+    # config.parent_form = "ApplicationForm"
+
+    # Method when creating the form files. Default is %w[new create edit update]
+    # config.form = %w[new create edit update]
+
+    # The operation files's parent class. Default is ApplicationOperation
+    # config.parent_operation = "ApplicationOperation"
+
+    # Save author name and timestamp to file. Default is true
+    # config.file_traces = true
+  end
+end
+```
+
+## Rollback generator
+
+If you want to rollback the hmvc-rails generator. You can run command
+
+```
+rails d hmvc_rails controller_name
+```
+
+## Test and debug gem on development environment
+
+- Add gem and run `bundle` (link to gem hmvc-rails project)
+
+```ruby
+group :development do
+  gem 'hmvc-rails', path: '../../Projects/hmvc-rails'
+  gem 'pry'
+end
+```
+
+- Add `binding.pry` to the line you want to test
+
+```ruby
+require 'pry'
+...
+def create_controller
+  binding.pry
+  template "controller.rb", File.join("app/controllers", class_path.join("/"), "#{file_name}_controller.rb")
+end
+```
+
+- Run command generator at Rails project terminal
+
+```
+rails g hmvc_rails admin
+```
+
+```
+   37: def create_controller
+=> 38:   binding.pry
+   39:   template "controllers/controller.rb",
+   40:            File.join("app/controllers", class_path.join("/"), "#{file_name}_controller.rb")
+   41: end
+
+[1] pry(#<HmvcRailsGenerator>)> options[:action]
+=> ["index", "show", "new", "create", "edit", "update", "destroy"]
+[2] pry(#<HmvcRailsGenerator>)>
+```
+
+- Code convention check
+
+```
+➜  hmvc-rails git:(main) rubocop
+Inspecting 14 files
+..............
+
+14 files inspected, no offenses detected
+```
+
+- Run unit test
+
+```
+➜  hmvc-rails git:(main) ✗ rake test
+Run options: --seed 9122
+
+# Running:
+
+.............
+
+Finished in 0.721364s, 18.0214 runs/s, 166.3515 assertions/s.
+13 runs, 120 assertions, 0 failures, 0 errors, 0 skips
+```
+
+## Configure rubocop
+
+If your project used rubocop for code convention. You can add the below configuration for some conventional hmvc-rails
+
+_.rubocop.yml_
+
+```ruby
+require: rubocop/cop/hmvc_rails_cops
+
+HmvcRails/OperatingStyle:
+  Enabled: true
+  Include:
+    - app/operations/**/*.rb
+
+HmvcRails/FormalStyle:
+  Enabled: true
+  Include:
+    - app/forms/**/*.rb
+```
+
+Example hmvc-rails offenses
+
+```
+➜  demo git:(master) ✗ rubocop
+Inspecting 48 files
+......C......C..................................
+
+Offenses:
+
+app/forms/admin/new_form.rb:6:1: C: HmvcRails/FormalStyle: The form filename does not match the desired format
+class Admin::NewFormm < ApplicationForm ...
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+app/operations/admin/new_operation.rb:6:1: C: HmvcRails/OperatingStyle: The operation filename does not match the desired format
+class Admin::NewOperationn < ApplicationOperation ...
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+app/operations/admin/new_operation.rb:7:3: C: HmvcRails/OperatingStyle: Method works in "call" without prefix "step_"
+  def call ...
+  ^^^^^^^^
+
+48 files inspected, 3 offenses detected
+```
+
+## License
+
+The gem `hmvc-rails` is copyright TOMOSIA VIET NAM CO., LTD
+
+## Contributor
+
+  - Thuc Phan T. thuc.phan@tomosia.com
+  - Minh Tang Q. minh.tang@tomosia.com
+
+## About [TOMOSIA VIET NAM CO., LTD](https://www.tomosia.com/)
+
+A company that creates new value together with customers and lights the light of happiness
+
+【一緒に】【ハッピー】【ライトアップ】
+
+お客様と共に新たな価値を生み出し幸せの明かりを灯す会社、トモシア

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rake/testtask"
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+end
+
+task default: :rubocop
+task default: :test