js_generator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ccd932f58631b5d8283c9efd1dcfcba05f98be590d217e2fff97400efa03c89
+  data.tar.gz: d5321b751356cd4b1ae09039ec1e262f6353845622cb5bab80a8f7ca85b5e7b2
+SHA512:
+  metadata.gz: eb460c52a67baeecbb05256a19e0d5cd91414d9754a84676887407d4abc927e08d9c0235f12736fcfb835ab1d69a67d4111bc5fb0a075bc8c9d87bb858538f6e
+  data.tar.gz: 534eff68babe22e0df2831e70e7c02f9b6e9aa85484a8b29cb76b2daf4c2e119dc62c619c4a6cedb75e6381f1fe1d315435b7946aea8f1d6dc0813d2a57fca44

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-26
+
+- 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 kenzou.kenzou104809@gmail.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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 kenzo-tanaka
+
+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,75 @@
+# JsGenerator
+
+This gem generates some JavaScript code with the specific rule.
+
+# 📌 Dependency
+
+- [dotenv](https://github.com/bkeepers/dotenv)
+
+# 📚 How to work
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'js_generator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Add this lines to `.env`:
+
+```text
+# set your js top namespace
+TOP_LEVEL_JS_NAMESPACE=Example
+```
+
+Run the command like this:
+
+```shell
+$ bundle exec js_generate admin/blogs/new 
+```
+
+This command generates these lines:
+
+- Create the js file for the view like `app/javascript/packs/views/admin/blogs/new.js`.
+- Write some codes below: 
+    ```js
+    // application.js
+    window.Example.Admin = window.Example.Admin || {};
+    window.Example.Admin.Blogs = window.Example.Admin.Blogs || {};
+    import AdminBlogsNew from './views/admin/blogs/new';
+    window.Example.Admin.Blogs.New = window.Example.Admin.Blogs.New || {};
+    window.Example.Admin.Blogs.New = AdminBlogsNew;
+    ```
+- Write `script` tag to the view file(e.g. `app/views/admin/blogs/new.html.erb`).
+    ```html
+    <script>
+      window.Example.Admin.Blogs.New();
+    </script>
+    ```
+
+# 🔍 `js_generate` command
+
+Here is the `js_generate` syntax. The `namespace` is optional.
+
+```shell
+$ bundle exec js_generate [namespace(optional)]/[model_name]/[action_name]
+
+# e.g. with namespace
+$ bundle exec js_generate admin/blogs/new
+
+# e.g.g without namespace
+$ bundle exec js_generate blogs/index 
+```
+
+# 🖥 Development
+
+```shell
+$ bin/setup
+```
+
+```shell
+$ bundle exec rspec
+```

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "js_generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/js_generate

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require_relative '../lib/js_generator'
+if ARGV.length != 1
+  raise ArgumentError.new("wrong number of arguments (given #{ARGV.length}, expected 1)")
+end
+
+args = ARGV[0].split('/')
+
+if args.length == 2
+  setup_js = JsGenerator::SetupJs.new(model_name: args[0], action_name: args[1])
+  setup_js.run
+else
+  setup_js = JsGenerator::SetupJs.new(namespace: args[0], model_name: args[1], action_name: args[2])
+  setup_js.run
+end
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/js_generator.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/js_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "js_generator"
+  spec.version       = JsGenerator::VERSION
+  spec.authors       = ["kenzo-tanaka"]
+  spec.email         = ["kenzou.kenzou104809@gmail.com"]
+
+  spec.summary       = "Generate JavaScript codes with the specific rule."
+  spec.description   = "Auto generate JavaScript codes with the specific rule."
+  spec.homepage      = "https://github.com/kenzo-tanaka/js_generator"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kenzo-tanaka/js_generator"
+  spec.metadata["changelog_uri"] = "https://github.com/kenzo-tanaka/js_generator/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = `git ls-files -z LICENSE.txt *.md *.gemspec bin lib`.split("\x0")
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "dotenv", "~> 2.7.6"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/js_generator/app_js.rb

@@ -0,0 +1,37 @@
+require 'dotenv'
+Dotenv.load
+require_relative './syntax_builder/namespaced'
+require_relative './syntax_builder/without_namespace'
+
+module JsGenerator
+  class AppJs
+    attr_reader :namespace, :model_name, :action_name, :top_level_js_namespace
+
+    def initialize(setup_js)
+      @namespace = setup_js.namespace
+      @model_name = setup_js.model_name
+      @action_name = setup_js.action_name
+      @top_level_js_namespace = setup_js.top_level_js_namespace
+    end
+
+    def append_script
+      File.open("app/javascript/packs/application.js", 'a') do |f|
+        f << syntax_builder.script_for_append
+      end
+    end
+
+    def action_namespace
+      syntax_builder.action_namespace
+    end
+
+    private
+
+    def syntax_builder
+      if namespace.present?
+        SyntaxBuilder::Namespaced.new(self)
+      else
+        SyntaxBuilder::WithoutNamespaced.new(self)
+      end
+    end
+  end
+end

data/lib/js_generator/js_for_view.rb

@@ -0,0 +1,63 @@
+module JsGenerator
+  class JsForView
+    attr_reader :namespace, :model_name, :action_name
+
+    def initialize(setup_js)
+      @namespace = setup_js.namespace
+      @model_name = setup_js.model_name
+      @action_name = setup_js.action_name
+    end
+
+    def create_file
+      make_view_dir
+      make_namespace_dir
+      make_model_dir
+      touch_file
+    end
+
+    private
+
+    def make_view_dir
+      Dir.mkdir(view_path) unless Dir.exist?(view_path)
+    end
+
+    def make_namespace_dir
+      return if Dir.exist?(namespace_path)
+      return if namespace.nil?
+
+      Dir.mkdir(namespace_path)
+    end
+
+    def make_model_dir
+      Dir.mkdir(model_path) unless Dir.exist?(model_path)
+    end
+
+    def touch_file
+      return if File.exist?(action_path)
+
+      File.open(action_path, 'w') { |f| f.write export_statement }
+    end
+
+    def view_path
+      "app/javascript/packs/views"
+    end
+
+    def namespace_path
+      "#{view_path}/#{namespace}"
+    end
+
+    def model_path
+      "#{namespace_path}/#{model_name.pluralize}"
+    end
+
+    def action_path
+      "#{model_path}/#{action_name}.js"
+    end
+
+    def export_statement
+      <<~TEXT
+        export default() => {}
+      TEXT
+    end
+  end
+end

data/lib/js_generator/syntax_builder/namespaced.rb

@@ -0,0 +1,39 @@
+require_relative './syntax_builder_base'
+
+module JsGenerator
+  module SyntaxBuilder
+    class Namespaced < SyntaxBuilderBase
+      def action_namespace
+        "window.#{top_level_js_namespace}.#{namespace.capitalize}.#{model_name.capitalize.pluralize}.#{action_name.capitalize}"
+      end
+
+      def script_for_append
+        <<~TEXT
+          #{define_namespace(custom_namespace)}
+          #{define_namespace(model_namespace)}
+          import #{import_name} from '#{import_path}';
+          #{action_namespace} = #{action_namespace} || {};
+          #{action_namespace} = #{import_name};
+        TEXT
+      end
+
+      private
+
+      def custom_namespace
+        "window.#{top_level_js_namespace}.#{namespace.capitalize}"
+      end
+
+      def model_namespace
+        "window.#{top_level_js_namespace}.#{namespace.capitalize}.#{model_name.capitalize.pluralize}"
+      end
+
+      def import_path
+        "./views/#{namespace}/#{model_name.pluralize}/#{action_name}"
+      end
+
+      def import_name
+        "#{namespace.capitalize}#{model_name.capitalize.pluralize}#{action_name.capitalize}"
+      end
+    end
+  end
+end

data/lib/js_generator/syntax_builder/syntax_builder_base.rb

@@ -0,0 +1,20 @@
+module JsGenerator
+  module SyntaxBuilder
+    class SyntaxBuilderBase
+      attr_reader :namespace, :model_name, :action_name, :top_level_js_namespace
+
+      def initialize(app_js)
+        @namespace = app_js.namespace
+        @model_name = app_js.model_name
+        @action_name = app_js.action_name
+        @top_level_js_namespace = app_js.top_level_js_namespace
+      end
+
+      private
+
+      def define_namespace(text)
+        File.read("app/javascript/packs/application.js").include?(text) ? nil : "#{text} = #{text} || {};"
+      end
+    end
+  end
+end

data/lib/js_generator/syntax_builder/without_namespace.rb

@@ -0,0 +1,34 @@
+require_relative './syntax_builder_base'
+
+module JsGenerator
+  module SyntaxBuilder
+    class WithoutNamespaced < SyntaxBuilderBase
+      def action_namespace
+        "window.#{top_level_js_namespace}.#{model_name.capitalize.pluralize}.#{action_name.capitalize}"
+      end
+
+      def script_for_append
+        <<~TEXT
+          #{define_namespace(model_namespace)}
+          import #{import_name} from '#{import_path}';
+          #{action_namespace} = #{action_namespace} || {};
+          #{action_namespace} = #{import_name};
+        TEXT
+      end
+
+      private
+
+      def model_namespace
+        "window.#{top_level_js_namespace}.#{model_name.capitalize.pluralize}"
+      end
+
+      def import_path
+        "./views/#{model_name.pluralize}/#{action_name}"
+      end
+
+      def import_name
+        "#{model_name.capitalize.pluralize}#{action_name.capitalize}"
+      end
+    end
+  end
+end

data/lib/js_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsGenerator
+  VERSION = "0.1.1"
+end

data/lib/js_generator/view_file.rb

@@ -0,0 +1,30 @@
+module JsGenerator
+  class ViewFile
+    attr_reader :namespace, :model_name, :action_name, :setup_js
+
+    def initialize(setup_js)
+      @namespace = setup_js.namespace
+      @model_name = setup_js.model_name
+      @action_name = setup_js.action_name
+      @setup_js = setup_js
+    end
+
+    def append_script
+      File.open(file_path, 'a') { |f| f << script_tag }
+    end
+
+    private
+
+    def file_path
+      "app/views/#{namespace}/#{model_name.pluralize}/#{action_name}.html.erb"
+    end
+
+    def script_tag
+      <<~TEXT
+        <script>
+          #{AppJs.new(setup_js).action_namespace}();
+        </script>
+      TEXT
+    end
+  end
+end

data/lib/js_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "js_generator/version"
+require_relative 'js_generator/js_for_view'
+require_relative 'js_generator/app_js'
+require_relative 'js_generator/view_file'
+require 'active_support/inflector'
+
+module JsGenerator
+  class Error < StandardError; end
+  class SetupJs
+    attr_reader :namespace, :model_name, :action_name
+    attr_accessor :top_level_js_namespace
+
+    def initialize(namespace: nil, model_name:, action_name:)
+      @namespace = namespace
+      @model_name = model_name
+      @action_name = action_name
+      @top_level_js_namespace = ENV['TOP_LEVEL_JS_NAMESPACE']
+    end
+
+    def run
+      if top_level_js_namespace.nil?
+        raise Error.new('Please set TOP_LEVEL_JS_NAMESPACE in .env')
+      end
+
+      JsForView.new(self).create_file
+      AppJs.new(self).append_script
+      ViewFile.new(self).append_script
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: js_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- kenzo-tanaka
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+description: Auto generate JavaScript codes with the specific rule.
+email:
+- kenzou.kenzou104809@gmail.com
+executables:
+- console
+- js_generate
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/js_generate
+- bin/setup
+- js_generator.gemspec
+- lib/js_generator.rb
+- lib/js_generator/app_js.rb
+- lib/js_generator/js_for_view.rb
+- lib/js_generator/syntax_builder/namespaced.rb
+- lib/js_generator/syntax_builder/syntax_builder_base.rb
+- lib/js_generator/syntax_builder/without_namespace.rb
+- lib/js_generator/version.rb
+- lib/js_generator/view_file.rb
+homepage: https://github.com/kenzo-tanaka/js_generator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kenzo-tanaka/js_generator
+  source_code_uri: https://github.com/kenzo-tanaka/js_generator
+  changelog_uri: https://github.com/kenzo-tanaka/js_generator/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Generate JavaScript codes with the specific rule.
+test_files: []