granule 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b082a65854e1aab6a3638fb0bc4c7f64f88cad69f685f67c681776ab10a772d3
-  data.tar.gz: 55ba22577d24d92d736d828b782d1465788ed4ce7970ff99b44e27202cf2afc4
+  metadata.gz: 36c6e3904ef0412b890f1ef65ed92960a3b1e914607989f387a4c124ad7ddd4a
+  data.tar.gz: 8412718336be9b9648da1fa3e653ac9e7b4580bf48c675e1f6f8f8a1bf0c3e86
 SHA512:
-  metadata.gz: db8be67c3a0f1ab0d79a127c9904b4d9158b0177f6e725f2c1397063505ccb8e77ef4d417545216cf6651055932580fc4d778f52fe935e841a41cc3602ec20b9
-  data.tar.gz: 4e8a189006214ce6f5b4c2504b2c9bb5c1089fdca8fab3e6db204561b6f96e94e6ad436286af3a55b7a5d5356b9a1a9e4ceb86591a49e6218ccd644933c2e716
+  metadata.gz: b1fb416fa5cbac9176c66047a08acc71c7f3239e00dec11f4718faea790b09ecdf5909520ef97b36da3bf03948d82cbf7eea7c1f3c361ff7a5337cc68ad8aad0
+  data.tar.gz: 6315f37cba131cc7a59aff0de80d8dc4697915b6b9ffb39e6a7e1aa692927b56c2718877b616da1d99ed86d31a3b16cc39fcec6b790738eb61f53a800f8f3d79

data/.github/workflows/ruby.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Get bundle dependencies
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -10,3 +10,5 @@
 # rspec failure tracking
 .rspec_status
 *.gem
+
+Gemfile.lock

data/.rubocop.yml

@@ -9,19 +9,20 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 
-Documentation:
-  Enabled: false
-
-FrozenStringLiteralComment:
-  Enabled: false
-
-Style/LambdaCall:
+Style/Documentation:
   Enabled: false
 
 Metrics/BlockLength:
+  Max: 50
   Exclude:
     - 'spec/**/*.rb'
     - '*.gemspec'
 
+Metrics/MethodLength:
+  Max: 50
+
 RSpec/MultipleExpectations:
   Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in granule.gemspec

data/README.md

@@ -1,45 +1,144 @@
 # Granule
+> Boilerplate/template/generator for Rails app
 
-Rails (5.2.3) template with useful gems and configs
+Rails (6.0.2) template with useful gems, configs and features. Ready for development out of the box. Dockerized for development.
 
-## Installation
+## Installing / Getting started
 
-    $ gem install granule
+A quick introduction of the minimal setup you need to get a hello world up & running.
 
-## Usage
-
-    $ granule new <NAME>
+```shell
+gem install granule
+```
 
+### Initial Configuration
 
-## What's inside?
+```shell
+granule new my-rails-app
+```
 
-### App
-
-    $ rails new -T --database=postgresql --webpack=react --skip-sprockets --skip-turbolinks
+Executes `rails new --skip-test --skip-bundle --database=postgresql --webpack=react --skip-turbolinks my-rails-app` under the hood.
 
 ### Gems
 
 Core
 
+* [bootsnap](https://github.com/Shopify/bootsnap) - library that plugs into Ruby, with optional support for ActiveSupport and YAML, to optimize and cache expensive computations
 * [devise](https://github.com/plataformatec/devise) - Authentication
 * [dry-matcher](https://github.com/dry-rb/dry-matcher) - Pattern matching for ruby. Used to unify controller handlers
 * [dry-monads](https://github.com/dry-rb/dry-monads) - Set of common monads for Ruby. Service Object/Interactor.
 * [dry-validation](https://github.com/dry-rb/dry-validation) - Validation library with type-safe schemas and rules.
 * [i18n-js](https://github.com/fnando/i18n-js) - Small library to provide the I18n translations on the Javascript
-* [react-rails](https://github.com/reactjs/react-rails) - React + Rails + Webpacker as a monolith app
+* [mini_magick](https://github.com/minimagick/minimagick) - mini replacement for RMagick
+* [pg](https://github.com/ged/ruby-pg) - A PostgreSQL client library for Ruby
+* [data_migrate](https://github.com/ilyakatz/data-migrate) - Migrate and update data alongside your database structure.
+* [puma](https://github.com/puma/puma) - A Ruby/Rack web server built for concurrency
 * [rolify](https://github.com/RolifyCommunity/rolify) - Role management library with resource scoping
 * [webpacker](https://github.com/rails/webpacker) - Bundling JavaScript assets
 
 Development
 
-* TBD
+* [better_errors](https://github.com/BetterErrors/better_errors) - Replaces the standard Rails error page with a much better and more useful error page
+* [letter_opener_web](https://github.com/fgrehm/letter_opener_web) - A web interface for browsing Ruby on Rails sent emails
+* [listen](https://github.com/guard/listen) (default) - Listens to file modifications and notifies you about the changes. (Used for spring)
+* [spring](https://github.com/rails/spring) (default) - Rails application preloader
+* [spring-watcher-listen](https://github.com/jonleighton/spring-watcher-listen) (default) - Makes Spring watch the filesystem for changes using Listen rather than by polling the filesystem.
+* [web-console](https://github.com/rails/web-console) (default) - Web Console is a debugging tool for your Ruby on Rails applications.
+
+Development + Test
+
+* [brakeman](https://github.com/presidentbeef/brakeman) - A static analysis security vulnerability scanner for Ruby on Rails applications
+* [bullet](https://github.com/flyerhzm/bullet) - Helps to kill N+1 queries and unused eager loading
+* [bundler-audit](https://github.com/rubysec/bundler-audit) - Patch-level verification for Bundler
+* [factory_bot_rails](https://github.com/thoughtbot/factory_bot_rails) - fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
+* [fasterer](https://github.com/DamirSvrtan/fasterer) - Fasterer will suggest some speed improvements which you can check in detail at the fast-ruby repo.
+* [ffaker](https://github.com/ffaker/ffaker) - Used to easily generate fake data: names, addresses, phone numbers, etc.
+* [i18n-tasks](https://github.com/glebm/i18n-tasks) - Manage translation and localization with static analysis, for Ruby i18n
+* [lol_dba](https://github.com/plentz/lol_dba) - small package of rake tasks that scan your application models and displays a list of columns that probably should be indexed. Also, it can generate .sql migration scripts
+* [pry-rails](https://github.com/rweng/pry-rails) - Causes rails console to open pry. It therefore depends on pry.
+* [pry-rescue](https://github.com/ConradIrwin/pry-rescue) - Whenever an exception is raised, but not rescued, pry-rescue will automatically open Pry for you:
+* [pry-stack_explorer](https://github.com/pry/pry-stack_explorer) - plugin for the Pry REPL that enables the user to navigate the call-stack
+* [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) - code metric tool to check the quality of Rails code.
+* [reek](https://github.com/troessner/reek) - Code smell detector for Ruby
+* [rubocop](https://github.com/rubocop-hq/rubocop) - A Ruby static code analyzer and formatter, based on the community Ruby style guide.
+* [rubocop-performance](https://github.com/rubocop-hq/rubocop-performance) - An extension of RuboCop focused on code performance checks.
+* [rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec) - Code style checking for RSpec files
+* [rubycritic](https://github.com/whitesmith/rubycritic) - A Ruby code quality reporter
 
 Test
 
-* TBD
+* [capybara](https://github.com/teamcapybara/capybara) - Acceptance test framework for web applications
+* [rspec-rails](https://github.com/rspec/rspec-rails) - RSpec for Rails-3+
+* [selenium-webdriver](https://github.com/SeleniumHQ/selenium) - Provides Ruby bindings for WebDriver
+* [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers) - Provides RSpec- and Minitest-compatible one-liners to test common Rails functionality that, if written by hand, would be much longer, more complex, and error-prone.
+* [simplecov](https://github.com/colszowka/simplecov) - Code coverage for Ruby 1.9+ with a powerful configuration library and automatic merging of coverage across test suites
+* [webdrivers](https://github.com/titusfortner/webdrivers) - Keep your Selenium WebDrivers updated automatically
+
+### Conventions
+
+#### Folder structure
+
+`feature folders` is convenient way to split business logic regarding controller actions.
+
+    .
+    ├── app
+    │   ├── controllers
+    │   │   ├── applications_controller.rb      # Default
+    │   │   └── sessions_controller.rb          # Typical rails controller
+    │   ├── core
+    │   │   ├── application_interactor.rb       # Parent interactor class
+    │   │   ├── application_contract.rb         # Parent contract class
+    │   │   └── session_create                  # Feature folder (controller_action name)
+    │   │       ├── contract.rb                 # params validations
+    │   │       ├── interactor.rb               # business logic
+    │   │       ├── policy.rb                   # authorization layer
+    │   │       ├── serializer.rb               # json presenter
+    │   │       └── you_name_it.rb              # custom logic
+    │   ...
+    ├── spec
+    │   ├── core
+    │   │   ├── session_create_spec.rb          # Unit tests input/output
+    │   │   ...
+    │   ├── request
+    │   │   ├── sessions_request_spec.rb        # Integration tests (SUCCESS/FAIL)
+    │   │   ...
+    │   └── system
+    │       ├── login_spec.rb                   # Rails System specs (using browser driver)
+    │       ...
+
+## Features
+
+What's all the bells and whistles this project can perform?
+* What's the main functionality
+* You can also do another thing
+* If you get really randy, you can even do this
+
+## Usage
+
+### Controllers
+
+TBD
+
+### Matchers
+
+TBD
+
+### Interactors
+
+TBD
+
+### Contracts
+
+TBD
+
+### Authorization
+
+TBD
 
 ## Contributing
 
+TBD
+
 Bug reports and pull requests are welcome on GitHub at https://github.com/leksster/granule. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'granule'

data/exe/granule

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bundler'
-require 'bundler/setup'
 require 'granule'
 
 Granule::CLI.start(ARGV)

data/granule.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'granule/version'

data/lib/granule/cli.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 require 'thor'
+require 'granule/feature/semantic_react'
+require 'granule/feature/devise_semantic'
 
 module Granule
   class CLI < Thor
     include Thor::Actions
 
-    DEFAULT_OPTIONS = '-T --database=postgresql '\
-                      '--webpack=react --skip-sprockets '\
-                      "--skip-turbolinks -m #{File.dirname __dir__}/granule/template.rb".freeze
+    DEFAULT_OPTIONS = '--skip-bundle --skip-webpack-install --skip-test --database=postgresql '\
+                      '--webpack=react'\
+                      "--skip-turbolinks -m #{File.dirname __dir__}/granule/new/base.rb"
 
     desc 'new DIRECTORY', 'Create a new rails app'
-
     def new(name)
       cmd = "rails new #{name} #{DEFAULT_OPTIONS}"
 
@@ -19,5 +22,17 @@ module Granule
         run(cmd)
       end
     end
+
+    desc 'feature NAME', 'available: semantic-devise'
+    def feature(name)
+      service = {
+        "semantic-react": Granule::Feature::SemanticReact,
+        "semantic-devise": Granule::Feature::DeviseSemantic
+      }[name.to_sym]
+
+      return unless service
+
+      service.new.call
+    end
   end
 end

data/lib/granule/feature/devise_semantic/devise.en.yml

@@ -0,0 +1,65 @@
+# Additional translations at https://github.com/plataformatec/devise/wiki/I18n
+
+en:
+  devise:
+    confirmations:
+      confirmed: "Your email address has been successfully confirmed."
+      send_instructions: "You will receive an email with instructions for how to confirm your email address in a few minutes."
+      send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
+    failure:
+      already_authenticated: "You are already signed in."
+      inactive: "Your account is not activated yet."
+      invalid: "Invalid %{authentication_keys} or password."
+      locked: "Your account is locked."
+      last_attempt: "You have one more attempt before your account is locked."
+      not_found_in_database: "Invalid %{authentication_keys} or password."
+      timeout: "Your session expired. Please sign in again to continue."
+      unauthenticated: "You need to sign in or sign up before continuing."
+      unconfirmed: "You have to confirm your email address before continuing."
+    mailer:
+      confirmation_instructions:
+        subject: "Confirmation instructions"
+      reset_password_instructions:
+        subject: "Reset password instructions"
+      unlock_instructions:
+        subject: "Unlock instructions"
+      email_changed:
+        subject: "Email Changed"
+      password_change:
+        subject: "Password Changed"
+    omniauth_callbacks:
+      failure: "Could not authenticate you from %{kind} because \"%{reason}\"."
+      success: "Successfully authenticated from %{kind} account."
+    passwords:
+      no_token: "You can't access this page without coming from a password reset email. If you do come from a password reset email, please make sure you used the full URL provided."
+      send_instructions: "You will receive an email with instructions on how to reset your password in a few minutes."
+      send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
+      updated: "Your password has been changed successfully. You are now signed in."
+      updated_not_active: "Your password has been changed successfully."
+    registrations:
+      destroyed: "Bye! Your account has been successfully cancelled. We hope to see you again soon."
+      signed_up: "Welcome! You have signed up successfully."
+      signed_up_but_inactive: "You have signed up successfully. However, we could not sign you in because your account is not yet activated."
+      signed_up_but_locked: "You have signed up successfully. However, we could not sign you in because your account is locked."
+      signed_up_but_unconfirmed: "A message with a confirmation link has been sent to your email address. Please follow the link to activate your account."
+      update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and follow the confirmation link to confirm your new email address."
+      updated: "Your account has been updated successfully."
+      updated_but_not_signed_in: "Your account has been updated successfully, but since your password was changed, you need to sign in again"
+    sessions:
+      signed_in: "Signed in successfully."
+      signed_out: "Signed out successfully."
+      already_signed_out: "Signed out successfully."
+    unlocks:
+      send_instructions: "You will receive an email with instructions for how to unlock your account in a few minutes."
+      send_paranoid_instructions: "If your account exists, you will receive an email with instructions for how to unlock it in a few minutes."
+      unlocked: "Your account has been unlocked successfully. Please sign in to continue."
+  errors:
+    messages:
+      already_confirmed: "was already confirmed, please try signing in"
+      confirmation_period_expired: "needs to be confirmed within %{period}, please request a new one"
+      expired: "has expired, please request a new one"
+      not_found: "not found"
+      not_locked: "was not locked"
+      not_saved:
+        one: "1 error prohibited this %{resource} from being saved:"
+        other: "%{count} errors prohibited this %{resource} from being saved:"