tailwind_views_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ef6570dde7818fce88ea2dad0a247dd74192a12595ef8632d76e230fdaae2fb
+  data.tar.gz: 07fcf1984092c48d4af6daae098a52a85744c86de70f043291ec1bff0352513a
+SHA512:
+  metadata.gz: 3155abe4791ddcab539d6dd4791e08d0613f52e9f20e8e49c5b7035ccfa98685c24a3f69c465631956f7cf5f66e20a526568fa4a79640a54f40ef514fad8806e
+  data.tar.gz: 36aa93b65f88bfb513d7302b1c09ab715daac2ed184b3eda02d8f35262e27bf2ac554a8b3056ce8702eccf7c1b6b195d5f330ee53df698cb023f579d62c3e075

data/.fasterer.yml

@@ -0,0 +1,23 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
+
+exclude_paths:
+  - 'docs/'
+  - 'lib/tailwind_views_generator/templates/**/**'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.vscode
+.idea

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: disable
+  Exclude:
+    - '**.gem'
+    - '**.gemspec'
+    - Gemfile
+    - Guardfile
+    - Rakefile
+    - 'bin/**'
+    - 'docs/**/*'
+    - 'hidden/**/*'
+    - 'lib/tailwind_views_generator/templates/**/*'
+    - 'node_modules/**/*'
+    - 'pkg/**/*'
+    - 'test/**/*'
+    - 'vendor/**/*'
+    - '**/*.tt'
+    - '**/*.erb'
+    - '**/*.slim'
+    - '**/*.haml'
+    - '**/*.yml'
+    - '.**'
+  TargetRubyVersion: 2.6
+  UseCache: true
+
+Layout/LineLength:
+  Max: 137
+Metrics/AbcSize:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start('rails') do
+  add_filter('/bin/')
+  add_filter('/lib/templates/**.**')
+end
+SimpleCov.minimum_coverage(90)
+SimpleCov.use_merging(false)

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.5

data/.yardopts

@@ -0,0 +1,12 @@
+--title 'TailwindViewsGenerator'
+--quiet
+--exclude lib/tailwind_views_generator/templates
+--exclude lib/tailwind_views_generator/generators
+--exclude spec
+--asset docs/images:images
+-
+CHANGELOG.md
+LICENSE
+README.md
+*.md
+# Docs -> https://manpages.debian.org/stretch/yard/yardoc.1

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 2021-04-14
+
+- Initial commit

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers 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. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tailwind_views_generator.gemspec
+gemspec
+
+gem 'rake'
+
+group :developmentt do
+  # gem 'rubocop', require: false
+  # gem 'rubocop-performance', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    tailwind_views_generator (0.0.1)
+      railties (>= 4.0, <= 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.1)
+      actionview (= 6.1.1)
+      activesupport (= 6.1.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.1)
+      activesupport (= 6.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (>= 1.17, <= 3)
+  minitest
+  rake
+  rubocop
+  rubocop-performance
+  tailwind_views_generator!
+
+BUNDLED WITH
+   2.2.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Brandon Hicks
+
+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,121 @@
+# Tailwind Views Generator
+
+![](https://ruby-gem-downloads-badge.herokuapp.com/tailwind_views_generator?type=total)  [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![Gem Version](https://badge.fury.io/rb/tailwind_views_generator.svg)](https://badge.fury.io/rb/tailwind_views_generator)
+
+This gem is used for generating tailwind based scaffold views for your Rails application. They can be Erb, Slim, or HAML. You can include pagination (using Pagy), simple_form (for the form components), and if you'd like you can utilize the meta-tags gems to all dynamic page titles when switching between your view components.
+
+This is more or less a sister project of the [bootstrap_views_generator](https://github.com/tarellel/bootstrap_views_generator) and [semantic_ui_views_generator](https://github.com/tarellel/semantic_ui_views_generator) gems, but for those who prefer to use TailwindCSS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tailwind_views_generator', group: :development
+
+# Before continuing make sure you have the tailwind yarn package or rails tailwind gem installed and included in your application.scss file so tailwind will be available for the applications frontend
+gem 'tailwindcss-rails'
+
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tailwind_views_generator
+
+## Usage
+
+```shell
+Usage:
+  rails g tailwind_views:install [options]
+
+Options:
+Options:
+-t, [--template-engine=TEMPLATE_ENGINE]     # Indicates when to generate using a designated template engine (erb, slim, haml)
+                                            # Default: erb
+--simpleform                                # Indicates if simple_form is to be used to generate the forms
+                                            # Default: false
+--pagination                                # Specify if you want to add pagination to the index pages
+                                            # Defaults: false (requires Pagy to use pagination)
+--metatags                                  # If you want the pages titles to use the meta-tags gem function for the page title
+                                            # Default: false
+--layout                                    # Over-write your application layout file with a Tailwind based layout
+                                            # Default: false
+--devise                                    # If you want to generate tailwind based devise views
+                                            # Default: false
+--skip_javascript                           # If you want to skip adding javascript_include_tag || javascript_pack_tag to the layouts
+                                            # Default: false
+--skip_turbolinks                           # Do you want to skip associating turbolinks with the assets and views
+                                            # Default: false
+```
+
+## Options
+
+##### Template Engines
+
+Supported Template Engines
+
+* ERB
+* HAML
+* Slim
+
+**HAML**
+
+Make sure you have haml added to your your Gemfile
+```ruby
+gem 'haml-rails'
+
+# generate haml views
+rails g tailwind_views:install --template_engine=haml
+```
+
+**Slim**
+Make sure you have Slim added to your Gemfile
+```ruby
+gem 'slim-rails'
+
+# generate Slim views
+rails g tailwind_views:install --template_engine=slim
+```
+
+#### Pagination
+
+Ensure you have [Pagy](https://github.com/ddnexus/pagy) gem installed
+```ruby
+gem 'pagy'
+```
+
+And ensure you have pagy's [tailwind extras](https://ddnexus.github.io/pagy/extras/tailwind) included in your applications stylesheets to format your pagination.
+
+
+#### Meta-Tags
+Ensure you have the [meta-tags](https://github.com/kpumuk/meta-tags) gem installed
+```ruby
+gem 'meta-tags'
+```
+
+### Examples
+
+Generate tailwind views with pagination enabled
+```shell
+rails g tailwind_views:install --pagination
+```
+
+Generate tailwind views with slim and using simple_form
+```shell
+rails g tailwind_views:install --template_engine=slim --simpleform
+```
+
+Generate tailwind scaffolds, devise views, while using simpleform, metatags, and slim template engine.
+```shell
+ rails g tailwind_views:install --devise --simpleform --metatags --template_engine=slim
+```
+
+### Extras
+
+* If you like to use the [meta-tags](https://github.com/kpumuk/meta-tags) gem to add page titles based on the views.
+* Pagination defaults to using [Pagy](https://github.com/ddnexus/pagy) on the index pages.
+* With [simple_form](https://github.com/plataformatec/simple_form) it generates a `config/initializers/simple_form.rb` file for your simple_form formatting.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tailwind_views_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/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