yamls 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82775f5c26eb978b61f1ebdb112f662c31362ca8d2c7b6cb8f36cd0969b65e96
-  data.tar.gz: 846d19e0e4ae7a8b90604cc7cbe9d7ab568800b0dcd7af6782f78d8d2f5a0ce9
+  metadata.gz: 332114e46336763e257777b1711843bf377a9b60ce6a3bf67849ab3becd09c49
+  data.tar.gz: c5f9b03ddeb224f8df226405c78ed2412d7039b12c06da6cec51d3655d768a88
 SHA512:
-  metadata.gz: bcb2781002fb52b97f21ee05ad1aa0066f119c33f05329258920e42d2bd5ee4b56b021ac88c2a2669bc663f6fddaa6db1117b11c118443ef195d759024067192
-  data.tar.gz: 1525fe499ff1eb9ee0124e358e4b6e5c0c9cc12e4c93633451ac22e49d10204a22f5841a2dcea8c4e5140ede4b916bc5ab282943e99ebe95b874376b0f9ad3d3
+  metadata.gz: 5215b874ba933c2bbd9480d67d5300e06e31ec93d23299a3786d8c7a0b3855af1c6962e7ed395500f75c2b62c7617d737e87d04549cabc76f0895fcc9db72dd2
+  data.tar.gz: 1cabfeb2b743b2e7fdd942c2346c09a2950acd8b8b567f11a99943e55ecbd19ecdddcb295c68ad29bb45af75504fbe0b72b2634a5f03d1e48137dc10a0f102a0

data/.circleci/config.yml

@@ -48,6 +48,27 @@ jobs:
           name: Run test
           command: cd example/rails5 && bundle exec rake test
 
+  test_rails6_0_0:
+    docker:
+      - image: cimg/ruby:3.0.2-node
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: sudo apt-get update -y && sudo apt-get install -y libsqlite3-dev
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - run:
+          name: Bundle install
+          command: cd example/rails6.0.0 && bundle install --path vendor/bundle
+      - run:
+          name: Setup db
+          command: cd example/rails6.0.0 && bundle exec rails db:migrate
+      - run:
+          name: Run test
+          command: cd example/rails6.0.0 && bundle exec rake test
 
 # Invoke jobs via workflows
 # See: https://circleci.com/docs/2.0/configuration-reference/#workflows
@@ -59,3 +80,6 @@ workflows:
       - test_rails5:
           requires:
             - build
+      - test_rails6_0_0:
+          requires:
+            - build

data/CHANGELOG.md

@@ -3,3 +3,8 @@
 ## [0.1.0] - 2021-10-28
 
 - Initial release
+
+## [0.2.0] - 2021-11-1
+
+- Add support function
+  - Add that can be include Yamls::Support::Parameters

data/README.md

@@ -1,10 +1,11 @@
 # Yamls
 
+[![Gem Version](https://badge.fury.io/rb/yamls.svg)](https://badge.fury.io/rb/yamls)
 [![CircleCI](https://circleci.com/gh/TsuMakoto/yamls/tree/main.svg?style=svg)](https://circleci.com/gh/TsuMakoto/yamls/tree/main)
 
 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/yamls`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+A gem that simplifies strong parameters that lengthen the code in Rails.
 
 ## Installation
 
@@ -24,7 +25,216 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In ActionController:
+
+Before:
+
+```ruby
+def person_params
+  params
+    .require(:person)
+    .permit(
+      :name,
+      :email,
+      :first_name,
+      :last_name,
+      :age,
+      :role,
+      # ....other
+    )
+end
+```
+
+Use gem:
+
+```ruby
+def person_params
+  Yamls::Parameters.new(
+    params,
+    model: :person,
+    action: :post
+  ).permit
+end
+```
+
+In Yaml file (default: app/parameters/column.yml):
+
+```yml
+person:
+  post:
+    - name
+    - email
+    - first_name
+    - last_name
+    - age
+    - role
+    # ... other
+```
+
+### Include support function
+
+If action_name and controller_name(with singularize) are the same as yaml configuration, it can be described below.
+
+```ruby
+class BooksController < ApplicationController
+  include Yamls::Support::Parameters
+
+  def action_name_1
+    params = yamls
+  end
+
+  def action_name_2
+    params = yamls
+  end
+
+  def action_name_3
+    params = yamls
+  end
+end
+```
+
+In Yaml file:
+
+```yml
+book:
+  action_name_1:
+    # set columns
+  action_name_2:
+    # set columns
+  action_name_3:
+    # set columns
+```
+
+### Initialize configuration
+
+1) If you want to specify a file:
+
+```ruby
+Yamls::Parameters.new(
+  params,
+  file_path: "path/to/column.yml"
+)
+
+```
+
+2) Nested parameters:
+
+In Yaml file:
+
+```yml
+main:
+  nested1:
+    nested2:
+      nested3:
+        - name
+        - label
+        - values:
+            - a_site
+            - b_site
+            - c_site
+```
+
+Request params:
+
+```json
+
+{
+    "books": {
+        "name": "Books name",
+        "label": "Books label",
+        "values": {
+            "a_site": 1000,
+            "b_site": 2000,
+            "c_site": 3000
+        }
+    }
+}
+
+```
+
+In controller:
+
+```ruby
+Yamls::Parameters.new(
+  params,
+  required: :book,
+  nested:   %i[main nested1 neste2 neste3]
+)
+
+```
+
+3) Model specification only:
+
+If the parameters of create and update are the same, you want to combine them into one.
+
+```yml
+book:
+  - name
+  - label
+  - value
+
+```
+
+```ruby
+Yamls::Parameters.new(
+  params,
+  model: :book,
+)
+
+```
+
+4) If you don't need a require method chain:
+
+```yml
+book:
+  - name
+  - label
+  - value
+
+```
+
+Request params:
+
+```json
+
+{
+    "name": "Books name",
+    "label": "Books label",
+    "value":  1000
+}
+
+```
+
+In controller:
+
+```ruby
+Yamls::Parameters.new(
+  params,
+  nested: %i[book]  # if you have a yaml with multi level
+)
+
+```
+
+or
+
+```ruby
+Yamls::Parameters.new(
+  params,
+  model: :book,
+  required: nil
+)
+
+```
+
+```ruby
+Yamls::Parameters.new(
+  params,
+  action: :book,
+  required: nil
+)
+
+```
+
 
 ## Development
 

data/example/rails5/Gemfile

@@ -25,7 +25,7 @@ gem 'puma', '~> 3.11'
 # Reduces boot times through caching; required in config/boot.rb
 gem 'bootsnap', '>= 1.1.0', require: false
 
-gem 'yamls'
+gem 'yamls', '~> 0.2.0'
 
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
 # gem 'rack-cors'

data/example/rails5/app/controllers/books_controller.rb

@@ -1,6 +1,8 @@
 class BooksController < ApplicationController
   before_action :set_book, only: [:show, :update, :destroy]
 
+  include Yamls::Support::Parameters
+
   # GET /books
   def index
     @books = Book.all
@@ -46,10 +48,6 @@ class BooksController < ApplicationController
 
     # Only allow a trusted parameter "white list" through.
     def book_params
-      Yamls::Parameters.new(
-        params,
-        model: :book,
-        action: action_name,
-      ).permit
+      params.require(:book).permit(:name, :label, :value)
     end
 end

data/example/rails5/app/controllers/people_controller.rb

@@ -48,7 +48,7 @@ class PeopleController < ApplicationController
     def person_params
       Yamls::Parameters.new(
         params,
-        model: :people,
+        model: :person,
         action: :post
       ).permit
     end

data/example/rails5/db/migrate/{20211031043641_create_people.rb → 20211031170917_create_people.rb}

@@ -2,8 +2,8 @@ class CreatePeople < ActiveRecord::Migration[5.2]
   def change
     create_table :people do |t|
       t.string :name
-      t.string :age
-      t.string :role
+      t.integer :age
+      t.integer :role
 
       t.timestamps
     end

data/example/rails5/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2021_10_31_052741) do
+ActiveRecord::Schema.define(version: 2021_10_31_170917) do
 
   create_table "books", force: :cascade do |t|
     t.string "name"
@@ -22,8 +22,8 @@ ActiveRecord::Schema.define(version: 2021_10_31_052741) do
 
   create_table "people", force: :cascade do |t|
     t.string "name"
-    t.string "age"
-    t.string "role"
+    t.integer "age"
+    t.integer "role"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
   end

data/example/rails5/test/controllers/books_controller_test.rb

@@ -12,13 +12,7 @@ class BooksControllerTest < ActionDispatch::IntegrationTest
 
   test "should create book" do
     assert_difference('Book.count') do
-      post books_url, params: {
-        book: {
-          name: "test-book",
-          label: "test-label",
-          value: 1500
-        }
-      }, as: :json
+      post books_url, params: { book: { label: @book.label, name: @book.name, value: @book.value } }, as: :json
     end
 
     assert_response 201
@@ -30,13 +24,7 @@ class BooksControllerTest < ActionDispatch::IntegrationTest
   end
 
   test "should update book" do
-    patch book_url(@book), params: {
-      book: {
-        name: "test-book",
-        label: "test-label",
-        value: 1500
-      }
-    }, as: :json
+    patch book_url(@book), params: { book: { label: @book.label, name: @book.name, value: @book.value } }, as: :json
     assert_response 200
   end
 

data/example/rails5/test/controllers/people_controller_test.rb

@@ -12,13 +12,7 @@ class PeopleControllerTest < ActionDispatch::IntegrationTest
 
   test "should create person" do
     assert_difference('Person.count') do
-      post people_url, params: {
-        people: {
-          name: "test01",
-          age: 10,
-          role: 0
-        }
-      }, as: :json
+      post people_url, params: { person: { age: @person.age, name: @person.name, role: @person.role } }, as: :json
     end
 
     assert_response 201
@@ -30,13 +24,7 @@ class PeopleControllerTest < ActionDispatch::IntegrationTest
   end
 
   test "should update person" do
-    patch person_url(@person), params: {
-      people: {
-        name: "test01",
-        age: 10,
-        role: 0
-      }
-    }, as: :json
+    patch person_url(@person), params: { person: { age: @person.age, name: @person.name, role: @person.role } }, as: :json
     assert_response 200
   end
 

data/example/rails5/test/fixtures/books.yml

@@ -1,10 +1,11 @@
 # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
-# This model initially had no columns defined. If you add columns to the
-# model remove the '{}' from the fixture names and add the columns immediately
-# below each fixture, per the syntax in the comments below
-#
 one:
-  name: book1
-  label: test-laebl
-  value: 1000
+  name: MyString
+  label: MyString
+  value: 1
+
+two:
+  name: MyString
+  label: MyString
+  value: 1

data/example/rails5/test/fixtures/people.yml

@@ -1,10 +1,11 @@
 # Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
-# This model initially had no columns defined. If you add columns to the
-# model remove the '{}' from the fixture names and add the columns immediately
-# below each fixture, per the syntax in the comments below
-#
 one:
-  name: test
-  age: 0
-  role: 0
+  name: MyString
+  age: 1
+  role: 1
+
+two:
+  name: MyString
+  age: 1
+  role: 1

data/example/rails6.0.0/.gitignore

@@ -0,0 +1,33 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+/vendor/

data/example/rails6.0.0/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/example/rails6.0.0/Gemfile

@@ -0,0 +1,43 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '3.0.2'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
+gem 'rails', '~> 6.0.4', '>= 6.0.4.1'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '~> 1.4'
+# Use Puma as the app server
+gem 'puma', '~> 4.1'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+# gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.2', require: false
+
+gem 'yamls', '~> 0.2.0'
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  gem 'listen', '~> 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/example/rails6.0.0/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/example/rails6.0.0/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/example/rails6.0.0/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/example/rails6.0.0/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/example/rails6.0.0/app/controllers/books_controller.rb

@@ -0,0 +1,53 @@
+class BooksController < ApplicationController
+  before_action :set_book, only: [:show, :update, :destroy]
+
+  include Yamls::Support::Parameters
+
+  # GET /books
+  def index
+    @books = Book.all
+
+    render json: @books
+  end
+
+  # GET /books/1
+  def show
+    render json: @book
+  end
+
+  # POST /books
+  def create
+    @book = Book.new(book_params)
+
+    if @book.save
+      render json: @book, status: :created, location: @book
+    else
+      render json: @book.errors, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /books/1
+  def update
+    if @book.update(book_params)
+      render json: @book
+    else
+      render json: @book.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /books/1
+  def destroy
+    @book.destroy
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_book
+      @book = Book.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def book_params
+      yamls
+    end
+end

data/example/rails6.0.0/app/controllers/people_controller.rb

@@ -0,0 +1,55 @@
+class PeopleController < ApplicationController
+  before_action :set_person, only: [:show, :update, :destroy]
+
+  # GET /people
+  def index
+    @people = Person.all
+
+    render json: @people
+  end
+
+  # GET /people/1
+  def show
+    render json: @person
+  end
+
+  # POST /people
+  def create
+    @person = Person.new(person_params)
+
+    if @person.save
+      render json: @person, status: :created, location: @person
+    else
+      render json: @person.errors, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /people/1
+  def update
+    if @person.update(person_params)
+      render json: @person
+    else
+      render json: @person.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /people/1
+  def destroy
+    @person.destroy
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_person
+      @person = Person.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def person_params
+      Yamls::Parameters.new(
+        params,
+        model: :person,
+        action: :post
+      ).permit
+    end
+end

data/example/rails6.0.0/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/example/rails6.0.0/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end