yamls 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 183fe67e715399097c4512be7c0d62763c4704f8000fec7b87cbede246cea17e
-  data.tar.gz: 1c95933c487b318623f39e1acd4eb6054883deb2131395962bc537683e3599ad
+  metadata.gz: 95135382a783cffc3c5095e2d464749065409c9f5aa06fe1e10b49aaf1ab22d3
+  data.tar.gz: '0618a4f351da6238b969b8919fbf65a906d1de9f5c63cce51b4d89a00ff70e31'
 SHA512:
-  metadata.gz: eed6e4d64f7da2ace01abe30755cf5beae02bdb0d462eba55fed83089a6c299cf05a8150f5c33c0a8724e1b37840881a688e8edcb6744c813fc94d54845ee651
-  data.tar.gz: 7a572b43cd5b08835d126c0a481e572183f8e66a066b776231e91df2e8ce97ce7f0a54f7024cebc0ddae8126fc77e621a14ca05acbedf53df79c5ecd556cc06b
+  metadata.gz: 2c8f84381f2d76891a2a4c3e62cd52b5a441ee5dc23f5ed4253dabc30469fa73fd3926940a88694f188b44c3fef27e05c673c176ad52709017b5af54ac7590ec
+  data.tar.gz: 12692960dc0e66af945b5576a1fb5620ffbbfa81c040e4a1859d0383f0ca7c41ee64f0380f3feabc0efb4f3a7be09a67286781021c181015ca9bd2b550de463c

data/.circleci/config.yml

@@ -48,6 +48,49 @@ 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
+
+  test_rails_demo:
+    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/rails-demo && bundle install --path vendor/bundle
+      - run:
+          name: Setup db
+          command: cd example/rails-demo && bundle exec rails db:migrate
+      - run:
+          name: Run test
+          command: cd example/rails-demo && bundle exec rake test
 
 # Invoke jobs via workflows
 # See: https://circleci.com/docs/2.0/configuration-reference/#workflows
@@ -59,3 +102,9 @@ workflows:
       - test_rails5:
           requires:
             - build
+      - test_rails6_0_0:
+          requires:
+            - build
+      - test_rails_demo:
+          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,237 @@ 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
+```
+
+Define method:
+
+```ruby
+class BooksController < ApplicationController
+  include Yamls::Support::Parameters
+
+  def action_name_1
+    params = book_action_name_1_params # {controller_name.singularize}_{action_name}_params
+  end
+
+  def action_name_2
+    params = book_action_name_2_params
+  end
+
+  def action_name_3
+    params = book_action_name_3_params
+  end
+end
+
+```
+
+### 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 nested2 nested3]
+)
+
+```
+
+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/rails-demo/.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/rails-demo/.ruby-version

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

data/example/rails-demo/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', path: "../../"
+
+# 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/rails-demo/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/rails-demo/app/channels/application_cable/channel.rb

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

data/example/rails-demo/app/channels/application_cable/connection.rb

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

data/example/rails-demo/app/controllers/application_controller.rb

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

data/example/rails-demo/app/controllers/books_controller.rb

@@ -0,0 +1,48 @@
+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_create_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_update_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
+end

data/example/rails-demo/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/rails-demo/app/mailers/application_mailer.rb

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

data/example/rails-demo/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/example/rails-demo/app/models/book.rb

@@ -0,0 +1,2 @@
+class Book < ApplicationRecord
+end

data/example/rails-demo/app/parameters/column.yml

@@ -0,0 +1,5 @@
+book:
+  create:
+    - name
+    - label
+    - value

data/example/rails-demo/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/example/rails-demo/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/example/rails-demo/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/example/rails-demo/bin/rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/example/rails-demo/bin/rake

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run