boring_generators 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e277610c48ddb35578742b883529c07b4d4b6dfd1c0291b38b0049ae6eab340
-  data.tar.gz: cfc446b54c8591a9eed4b583652a34a0b02a8c9535fd3ebdea54f1599685cb1b
+  metadata.gz: f53cde2e0fe1d3ac3886bda90938684dfb8a042b3a4af31029db3b4fbf1ff6c9
+  data.tar.gz: 6742553d35e0db7f76de45b7c72b26a5816019e53dae5337535b127598b956be
 SHA512:
-  metadata.gz: 7117cb3bef90a4c33edd5c980effa8272fc8669e2225ea85c81371262714ab68ed8122d56f83490331fca00ff619e2b35f788e2dbff83534f8c7fb567e76e17d
-  data.tar.gz: c055b5921c43dcb681364c2a5bbe99becf0c8559c057bd50ee96ea7731c260857a02ff6d75e0f1807418942100a5da6875a40f3bd74482b196cb4e37a9de1afe
+  metadata.gz: baa6c23aad5cafcb0d73df98d0169312503f6e603b51daf70e40fe11bba24c2a22d96867f127f075dfff6ebcf5d218485ba9e05c73f04e9d6f4b92c138c2bb5e
+  data.tar.gz: 44a4df93e880cdeb55f2de27a1442348403616f0238309999223a336ced1de9908b54e14a81519b395b379dc55c89fcdb0d4bce50b849ffe4cd0667255e5bd9d

data/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 ## master (unreleased)
 
-## 0.1.0 (September 16th, 2020)
+## 0.3.0 (September 19th, 2020)
+* Adds Bullet install generator. ([@abhaynikam][])
+* Adds Audit gems(bundler-audit, ruby_audit) install generator. ([@abhaynikam][])
+* Adds Pry install generator. ([@abhaynikam][])
+* Adds Active Storage Google install generator. ([@abhaynikam][])
+* Adds Active Storage AWS install generator. ([@abhaynikam][])
+* Adds Active Storage Microsoft Azure install generator. ([@abhaynikam][])
+
+## 0.2.0 (September 16th, 2020)
 * Adds JQuery install generator. ([@abhaynikam][])
 * Adds Bootstrap install generator. ([@abhaynikam][])
 * Adds FontAwesome install generator via Yarn. ([@abhaynikam][])

data/README.md

@@ -1,8 +1,8 @@
 # BoringGenerators
 
-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/boring_generators`. To experiment with that code, run `bin/console` for an interactive prompt.
+Have you ever started a new adventure/hobby project of your and instead of spending time in solving the actual problem statement with the website ended up configuring the application and put a lot of effort into it. Yeah, We felt that too. Boring generator tries to resolve the painful same redundant configuration you do in every application by adding generators to easily configure it.
 
-TODO: Delete this and the text above, and describe your gem
+Check out the generator we support right now. We are planning to add support to most of the mostly used and required gems. We are open to any idea of yours, feel free to raise a discussion by opening up an issue or try contributing.
 
 ## Installation
 
@@ -28,6 +28,12 @@ The boring generator introduces following generators:
 - 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`
+- Install Bullet: `rails generate boring:bullet:install`
+- Install Audit gems(bundler-audit, ruby_audit): `rails generate boring:audit:install`
+- Install Pry gems for easy debugging: `rails generate boring:pry:install`
+- Install Active Storage for Google Cloud Service: `rails generate boring:active_storage:google:install`
+- Install Active Storage for AWS: `rails generate boring:active_storage:aws:install`
+- Install Active Storage for Azure: `rails generate boring:active_storage:azure:install`
 
 ## Development
 
@@ -39,7 +45,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 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
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/boring_generators/version.rb

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

data/lib/generators/boring/active_storage/aws/install/install_generator.rb

@@ -0,0 +1,48 @@
+module Boring
+  module ActiveStorage
+    module Aws
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds ActiveStorage AWS service the application"
+
+        class_option :skip_active_storage, type: :boolean, aliases: "-s",
+                                           desc: "Skips running ActiveStorage installer"
+
+        def add_active_storage
+          unless options[:skip_active_storage]
+            say "Adding ActiveStorage", :green
+            run "bin/rails active_storage:install"
+          end
+        end
+
+        def add_aws_to_the_application
+          say "Adding AWS gem", :green
+          aws_gem_content = <<~RUBY
+            \n
+            # for AWS Service
+            gem "aws-sdk-s3", require: false
+          RUBY
+          append_to_file "Gemfile", aws_gem_content
+          run "bundle install"
+        end
+
+        def add_configuration_to_production
+          gsub_file "config/environments/production.rb",
+                    "config.active_storage.service = :local",
+                    "config.active_storage.service = :amazon"
+        end
+
+        def add_aws_storage_configuration
+          aws_storage_config_content = <<~RUBY
+            amazon:
+              service: S3
+              access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+              secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+              region: us-east-1
+              bucket: your_own_bucket
+          RUBY
+          append_to_file "config/storage.yml", aws_storage_config_content
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/active_storage/azure/install/install_generator.rb

@@ -0,0 +1,48 @@
+module Boring
+  module ActiveStorage
+    module Azure
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds ActiveStorage Mircosoft Azure the application"
+
+        class_option :skip_active_storage, type: :boolean, aliases: "-s",
+                                           desc: "Skips running ActiveStorage installer"
+
+        def add_active_storage
+          unless options[:skip_active_storage]
+            say "Adding ActiveStorage", :green
+            run "bin/rails active_storage:install"
+          end
+        end
+
+        def add_azure_to_the_application
+          say "Adding mircosoft azure gem", :green
+          azure_gem_content = <<~RUBY
+            \n
+            # for Azure Service
+            gem "azure-storage-blob", require: false
+          RUBY
+          append_to_file "Gemfile", azure_gem_content
+          run "bundle install"
+        end
+
+        def add_configuration_to_production
+          gsub_file "config/environments/production.rb",
+                    "config.active_storage.service = :local",
+                    "config.active_storage.service = :microsoft"
+        end
+
+        def add_azure_storage_configuration
+          microsoft_storage_config_content = <<~RUBY
+            microsoft:
+              service: AzureStorage
+              storage_account_name: your_account_name
+              storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+              container: your_container_name
+          RUBY
+
+          append_to_file "config/storage.yml", microsoft_storage_config_content
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/active_storage/google/install/install_generator.rb

@@ -0,0 +1,48 @@
+module Boring
+  module ActiveStorage
+    module Google
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds ActiveStorage google cloud service the application"
+
+        class_option :skip_active_storage, type: :boolean, aliases: "-s",
+                                           desc: "Skips running ActiveStorage installer"
+
+        def add_active_storage
+          unless options[:skip_active_storage]
+            say "Adding ActiveStorage", :green
+            run "bin/rails active_storage:install"
+          end
+        end
+
+        def add_google_cloud_storage_to_the_application
+          say "Adding google cloud storage gem", :green
+          google_cloud_storage_gem_content = <<~RUBY
+            \n
+            # for Google Cloud Storage Service
+            gem "google-cloud-storage", require: false
+          RUBY
+          append_to_file "Gemfile", google_cloud_storage_gem_content
+          run "bundle install"
+        end
+
+        def add_configuration_to_production
+          gsub_file "config/environments/production.rb",
+                    "config.active_storage.service = :local",
+                    "config.active_storage.service = :google"
+        end
+
+        def add_google_storage_configuration
+          google_storage_config_content = <<~RUBY
+            google:
+              service: GCS
+              project: your_project
+              credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+              bucket: your_own_bucket
+          RUBY
+
+          append_to_file "config/storage.yml", google_storage_config_content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Boring
+  module Audit
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Audit gems to the application"
+
+      def add_bullet_gem
+        say "Adding audit gems", :green
+        audit_gems_content = <<~RUBY
+          \n
+          \t# Patch-level verification for Bundler. https://github.com/rubysec/bundler-audit
+          \tgem "bundler-audit", require: false
+          \t# vulnerabity checker for Ruby itself. https://github.com/civisanalytics/ruby_audit
+          \tgem "ruby_audit", require: false
+        RUBY
+        insert_into_file "Gemfile", audit_gems_content, after: /group :development do/
+        run "bundle install"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Boring
+  module Bullet
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Bullet gem to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :skip_configuration, type: :boolean, aliases: "-s",
+                                        desc: "Skips adding bullet development configuration"
+
+      def add_bullet_gem
+        say "Adding Bullet gem", :green
+        bullet_gem_content = <<~RUBY
+          \n
+          \t# reports N+1 queries
+          \tgem "bullet"
+        RUBY
+        insert_into_file "Gemfile", bullet_gem_content, after: /group :development do/
+        run "bundle install"
+      end
+
+      def add_bullet_gem_configuration
+        return if options[:skip_configuration]
+
+        say "Copying bullet.rb configuration to the initializer", :green
+        template("bullet.rb", "config/initializers/bullet.rb")
+      end
+    end
+  end
+end

data/lib/generators/boring/bullet/install/templates/bullet.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+if Rails.env.development? && defined?(Bullet)
+  Bullet.enable = true
+  Bullet.bullet_logger = true
+  Bullet.rails_logger = true
+  Bullet.unused_eager_loading_enable = true
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Boring
+  module Pry
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds pry to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_bullet_gem
+        say "Adding Bullet gem", :green
+        pry_gem_content = <<~RUBY
+          \n
+          # for using pry as Rails console
+          gem "pry"
+          gem "pry-rails"
+        RUBY
+        append_to_file "Gemfile", pry_gem_content
+        run "bundle install"
+      end
+
+      def add_pryrc_configuration
+        return if options[:skip_configuration]
+
+        say "Copying pryrc configuration", :green
+        template("pryrc", ".pryrc")
+      end
+    end
+  end
+end

data/lib/generators/boring/pry/install/templates/pryrc

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "json"
+
+if defined?(Rails)
+  # https://wiki.hackzine.org/development/misc/readline-color-prompt.html
+  Pry.config.prompt_name = if Rails.env.production?
+    "\001\e[0m\002PROD"
+  else
+    "\001\e[0m\002dev"
+  end
+end
+Pry.config.pager = false
+
+def define_byebug_aliases!
+  if defined?(PryByebug)
+    Pry.commands.alias_command "c", "continue"
+    Pry.commands.alias_command "s", "step"
+    Pry.commands.alias_command "n", "next"
+    Pry.commands.alias_command "f", "finish"
+  end
+end
+
+extend Rails::ConsoleMethods if defined?(Rails::ConsoleMethods)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-20 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
@@ -34,12 +34,20 @@ files:
 - boring_generators.gemspec
 - lib/boring_generators.rb
 - lib/boring_generators/version.rb
+- lib/generators/boring/active_storage/aws/install/install_generator.rb
+- lib/generators/boring/active_storage/azure/install/install_generator.rb
+- lib/generators/boring/active_storage/google/install/install_generator.rb
+- lib/generators/boring/audit/install/install_generator.rb
 - lib/generators/boring/bootstrap/install/install_generator.rb
 - lib/generators/boring/bootstrap/install/templates/application.scss
+- lib/generators/boring/bullet/install/install_generator.rb
+- lib/generators/boring/bullet/install/templates/bullet.rb
 - 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/pry/install/install_generator.rb
+- lib/generators/boring/pry/install/templates/pryrc
 - lib/generators/boring/tailwind/install/install_generator.rb
 - lib/generators/boring/tailwind/install/templates/application.scss
 homepage: https://github.com/abhaynikam/boring_generators