boring_generators 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdb73c106d2605bd3f2a97cc509f2204dc7d74670f4b67685abebf01ea93e42a
-  data.tar.gz: dccbd9b93fd021b3fc4e8a567166d0d0134ddd4ec6a51251f3b4d18204ce6daf
+  metadata.gz: 4e277610c48ddb35578742b883529c07b4d4b6dfd1c0291b38b0049ae6eab340
+  data.tar.gz: cfc446b54c8591a9eed4b583652a34a0b02a8c9535fd3ebdea54f1599685cb1b
 SHA512:
-  metadata.gz: 2158a1c67c89389e4c17cd53df289bc623c47191253d2a4e9c1cb665e0c47ad0cf65ae92f290fbaf8a927028c150be8194ad8dc6e1a3f3744a56bc9d6168c290
-  data.tar.gz: c5b4082ae50708c0846aee643cd88fa9b7f40ed88766124f9eee86135f90b6e0a9e63760edce26d5dbe3748cf27b5794089b2c39ff3d6df5d891cf3eb82e19c6
+  metadata.gz: 7117cb3bef90a4c33edd5c980effa8272fc8669e2225ea85c81371262714ab68ed8122d56f83490331fca00ff619e2b35f788e2dbff83534f8c7fb567e76e17d
+  data.tar.gz: c055b5921c43dcb681364c2a5bbe99becf0c8559c057bd50ee96ea7731c260857a02ff6d75e0f1807418942100a5da6875a40f3bd74482b196cb4e37a9de1afe

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+<!--
+  Thanks for submitting a pull request!
+  We appreciate you spending the time to work on these changes. Please provide enough information so that others can review your pull request. The three fields below are mandatory.
+
+  Before submitting a pull request, please make sure the following is done:
+
+  1. Fork [the repository](https://github.com/abhaynikam/boring_generators) and create your branch from `master`.
+  2. Run `bundle install` in the repository root.
+  3. If you've fixed a bug or added code that should be tested, add tests!
+  4. Ensure the test suite passes (`rake test`).
+-->

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.1.0 (September 16th, 2020)
+* Adds JQuery install generator. ([@abhaynikam][])
+* Adds Bootstrap install generator. ([@abhaynikam][])
+* Adds FontAwesome install generator via Yarn. ([@abhaynikam][])
+* Adds FontAwesome install generator via RubyGems. ([@abhaynikam][])
+
 ## 0.1.0 (September 5th, 2020)
 
 * Adds Tailwind CSS install generator. ([@abhaynikam][])

data/README.md

@@ -22,7 +22,12 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The boring generator introduces following generators:
+- Install Tailwind CSS: `rails generate boring:tailwind:install`
+- Install Bootstrap: `rails generate boring:bootstrap:install`
+- Install JQuery: `rails generate boring:jquery:install`
+- Install FontAwesome via Yarn: `rails generate boring:font_awesome:yarn:install`
+- Install FontAwesome via RubyGems: `rails generate boring:font_awesome:ruby_gem:install`
 
 ## Development
 
@@ -32,7 +37,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/boring_generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/boring_generators/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhaynikam/boring_generators. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/abhaynikam/boring_generators/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +46,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the BoringGenerators project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/boring_generators/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the BoringGenerators project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abhaynikam/boring_generators/blob/master/CODE_OF_CONDUCT.md).

data/boring_generators.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/abhaynikam/boring-generators"
-  spec.metadata["changelog_uri"] = "https://github.com/abhaynikam/boring-generators."
+  spec.metadata["changelog_uri"] = "https://github.com/abhaynikam/boring_generators/blob/master/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.

data/lib/boring_generators/version.rb

@@ -1,3 +1,3 @@
 module BoringGenerators
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/boring/bootstrap/install/install_generator.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Boring
+  module Bootstrap
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Bootstrap to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_bootstrap_package
+        say "Adding bootstrap packages", :green
+        run "yarn add bootstrap jquery popper.js"
+      end
+
+      def add_jquery_plugin_provider_to_webpack_environment
+        say "Initailizing tailwind configuration", :green
+        if File.exist?("config/webpack/environment.js")
+          insert_into_file "config/webpack/environment.js", <<~RUBY, after: /@rails\/webpacker.*\n/
+            const webpack = require("webpack")
+
+            environment.plugins.append("Provide", new webpack.ProvidePlugin({
+              $: 'jquery',
+              jQuery: 'jquery',
+              Popper: ['popper.js', 'default']
+            }))
+          RUBY
+        else
+          say <<~WARNING, :red
+            ERROR: Looks like the webpacker installation is incomplete. Could not find environment.js in config/webpack.
+          WARNING
+        end
+      end
+
+      def add_or_import_stylesheet_for_bootstrap
+        if File.exist?("app/javascript/stylesheets/application.scss")
+          say "Add bootstrap imports to the application.scss", :green
+          append_to_file "app/javascript/stylesheets/application.scss" do
+            '@import "~bootstrap/scss/bootstrap";'
+          end
+        else
+          say "Copying application.scss with tailwind imports", :green
+          template("application.scss", "app/javascript/stylesheets/application.scss")
+        end
+      end
+
+      def insert_stylesheet_in_the_application
+        if File.exist?("app/javascript/packs/application.js")
+          application_js_content = <<~RUBY
+            \n
+            import "bootstrap"
+            import "stylesheets/application"
+          RUBY
+          append_to_file "app/javascript/packs/application.js", application_js_content
+        else
+          say <<~WARNING, :red
+            ERROR: Looks like the webpacker installation is incomplete. Could not find application.js in app/javascript/packs.
+          WARNING
+        end
+      end
+
+      def insert_stylesheet_packs_tag
+        insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /stylesheet_link_tag.*\n/
+          \t\t<%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/boring/bootstrap/install/templates/application.scss

@@ -0,0 +1 @@
+@import "~bootstrap/scss/bootstrap";

data/lib/generators/boring/font_awesome/ruby_gem/install/install_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Boring
+  module FontAwesome
+    module RubyGem
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds fontawesome via yarn to the application"
+
+        def add_font_awesome_sass_gem
+          say "Adding font_awesome_sass gem", :green
+
+          font_awesome_sass_gem = <<~RUBY
+            \n
+            # for adding font-awesome icons
+            gem 'font-awesome-sass', '~> 5.13'
+          RUBY
+          append_to_file "Gemfile", font_awesome_sass_gem
+          run "bundle install"
+        end
+
+        def import_font_awesome_stylesheet
+          say "Adding font awesome stylesheets", :green
+          stylesheet_font_awesome_imports = <<~RUBY
+            \n
+            @import "font-awesome-sprockets";
+            @import "font-awesome";
+          RUBY
+
+          if File.exist?("app/assets/stylesheets/application.css.scss")
+            append_to_file "app/assets/stylesheets/application.css.scss", stylesheet_font_awesome_imports
+          elsif File.exist?("app/assets/stylesheets/application.scss")
+            append_to_file "app/assets/stylesheets/application.scss", stylesheet_font_awesome_imports
+          else
+            say <<~WARNING, :red
+              ERROR: Looks like the application.css.scss is missing. Please rename the file and re-run the generator.
+            WARNING
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/font_awesome/yarn/install/install_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Boring
+  module FontAwesome
+    module Yarn
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+        desc "Adds fontawesome via rubygems to the application"
+
+        def add_font_awesome_package
+          say "Adding fontawesome packages", :green
+          run "yarn add @fortawesome/fontawesome-free"
+        end
+
+        def import_font_awesome_stylesheet
+          say "Adding font awesome stylesheets", :green
+          if File.exist?("app/javascript/stylesheets/application.scss")
+            stylesheet_font_awesome_imports = <<~RUBY
+              \n
+              @import '@fortawesome/fontawesome-free';
+            RUBY
+
+            append_to_file "app/javascript/stylesheets/application.scss", stylesheet_font_awesome_imports
+          else
+            say "Copying application.scss with FontAwesome imports", :green
+            template("application.scss", "app/javascript/stylesheets/application.scss")
+          end
+        end
+
+        def import_font_awesome_javascript
+          if File.exist?("app/javascript/packs/application.js")
+            javascript_font_awesome_imports = <<~RUBY
+              \n
+              import "@fortawesome/fontawesome-free/js/all"
+            RUBY
+
+            append_to_file "app/javascript/packs/application.js", javascript_font_awesome_imports
+          else
+            say <<~WARNING, :red
+              ERROR: Looks like the webpacker installation is incomplete. Could not find application.js in app/javascript/packs.
+            WARNING
+          end
+        end
+
+        def insert_stylesheet_packs_tag
+          insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /stylesheet_link_tag.*\n/
+            \t\t<%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/font_awesome/yarn/install/templates/application.scss

@@ -0,0 +1 @@
+@import '@fortawesome/fontawesome-free';

data/lib/generators/boring/jquery/install/install_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Boring
+  module Jquery
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds JQuery to the application"
+
+      def add_jquery_package
+        say "Adding JQuery packages", :green
+        run "yarn add jquery"
+      end
+
+      def add_jquery_plugin_provider_to_webpack_environment
+        say "Initailizing tailwind configuration", :green
+        if File.exist?("config/webpack/environment.js")
+          insert_into_file "config/webpack/environment.js", <<~RUBY, after: /@rails\/webpacker.*\n/
+            const webpack = require("webpack")
+
+            environment.plugins.append("Provide", new webpack.ProvidePlugin({
+              $: 'jquery',
+              jQuery: 'jquery'
+            }))
+          RUBY
+        else
+          say <<~WARNING, :red
+            ERROR: Looks like the webpacker installation is incomplete. Could not find environment.js in config/webpack.
+          WARNING
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/tailwind/install/install_generator.rb

@@ -37,30 +37,38 @@ module Boring
 
       def add_or_import_stylesheet_for_tailwind
         if File.exist?("app/javascript/stylesheets/application.scss")
-          say "Add tailwindcss imports to the application.scss", :green
-          append_to_file "app/javascript/stylesheets/application.scss" do
-            '@import "tailwindcss/base";'
-            '@import "tailwindcss/components";'
-            '@import "tailwindcss/utilities";'
+          say "Add TailwindCSS imports to the application.scss", :green
+          stylesheet_tailwind_imports = <<~RUBY
+            \n
+            @import "tailwindcss/base";
+            @import "tailwindcss/components";
+            @import "tailwindcss/utilities";
+          RUBY
 
-          end
+          append_to_file "app/javascript/stylesheets/application.scss", stylesheet_tailwind_imports
         else
-          say "Copying application.scss with tailwind imports", :green
+          say "Copying application.scss with Tailwind imports", :green
           template("application.scss", "app/javascript/stylesheets/application.scss")
+        end
+      end
 
-          if File.exist?("app/javascript/packs/application.js")
-            append_to_file "app/javascript/packs/application.js" do
-              'import "stylesheets/application"'
-            end
-          else
-            raise "Looks like the webpacker installation is incomplete. Could not find application.js in app/javascript/packs."
+      def insert_stylesheet_in_the_application
+        if File.exist?("app/javascript/packs/application.js")
+          append_to_file "app/javascript/packs/application.js" do
+            'import "stylesheets/application"'
           end
-
-          insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /stylesheet_link_tag.*\n/
-            <%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
-          RUBY
+        else
+          say <<~WARNING, :red
+            ERROR: Looks like the webpacker installation is incomplete. Could not find application.js in app/javascript/packs.
+          WARNING
         end
       end
+
+      def insert_stylesheet_packs_tag
+        insert_into_file "app/views/layouts/application.html.erb", <<~RUBY, after: /stylesheet_link_tag.*\n/
+          \t\t<%= stylesheet_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+        RUBY
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies: []
 description: Every new project or hobby project of yours needs to setup simple things.
   Boring generators aims to make your development faster by delegating boring setups
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -33,6 +34,12 @@ files:
 - boring_generators.gemspec
 - lib/boring_generators.rb
 - lib/boring_generators/version.rb
+- lib/generators/boring/bootstrap/install/install_generator.rb
+- lib/generators/boring/bootstrap/install/templates/application.scss
+- lib/generators/boring/font_awesome/ruby_gem/install/install_generator.rb
+- lib/generators/boring/font_awesome/yarn/install/install_generator.rb
+- lib/generators/boring/font_awesome/yarn/install/templates/application.scss
+- lib/generators/boring/jquery/install/install_generator.rb
 - lib/generators/boring/tailwind/install/install_generator.rb
 - lib/generators/boring/tailwind/install/templates/application.scss
 homepage: https://github.com/abhaynikam/boring_generators
@@ -41,7 +48,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/abhaynikam/boring_generators
   source_code_uri: https://github.com/abhaynikam/boring-generators
-  changelog_uri: https://github.com/abhaynikam/boring-generators.
+  changelog_uri: https://github.com/abhaynikam/boring_generators/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: