semantic_ui_views_generator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 449e81ca109162a7e8774a9cac8b2f3590acc99746cd3f1f9d216526d16728eb
+  data.tar.gz: 364364555140d12b5e237d6b6bcb899d38d1a422114094e564b9194d59871267
+SHA512:
+  metadata.gz: aacf03a69049dcd1af5ddf5f5648d79f6cad8eb2b701181f39ede85aab1549c40c537697411cff10ca82eb52783abacb77b28a333777a3a2b9d1845ab183954a
+  data.tar.gz: a11472343f81f2123c07754c266a64d044d529f4b1f1aa6acadcfeb18685545d030b768c7daf73584add744c164c2f557ba4f91b27dcfe5941332002d57ffe0d

data/.gitignore

@@ -0,0 +1,69 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore OS based config files
+*.swp
+*.Thumbs.db
+*.DS_Store
+*/.DS_Store
+.idea/*
+.backup/*
+
+# Ignore Rails generated caching files
+.sass-cache/
+.bundle/*
+vendor/bundle/
+vendor/cache/
+cache/*
+dump.rdb
+coverage/*
+
+
+# Ignore basic notes, docs, etc
+docs/*
+
+# Ignore Generated files, that should be build when pushing to production
+public/assets/
+public/javascripts/*.js
+public/packs
+public/stylesheets/*.css
+/node_modules
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+db/database.sqlite.yml
+db/database.oracle.yml
+db/data/seed.rb
+db/scheme.rb
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+# Node / Yarn package files
+node_modules/
+yarn-error.log
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+# Ignore application based files
+.idea
+.vagrant
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in semantic_ui_views_generator.gemspec
+gemspec
+
+gem 'railties', '>= 5.0'
+gem 'semantic-ui-sass', github: 'doabit/semantic-ui-sass'

data/Gemfile.lock

@@ -0,0 +1,89 @@
+GIT
+  remote: https://github.com/doabit/semantic-ui-sass
+  revision: 6c8e8dabb46b50fb5e01a4766a63c362501f0dc8
+  specs:
+    semantic-ui-sass (2.4.0.1)
+      sass (>= 3.2)
+
+PATH
+  remote: .
+  specs:
+    semantic_ui_views_generator (0.1.0)
+      railties (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    ffi (1.10.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    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.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.17)
+  railties (>= 5.0)
+  rake (>= 10.0)
+  semantic-ui-sass!
+  semantic_ui_views_generator!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,102 @@
+# SemanticViewsGenerator
+
+![](https://ruby-gem-downloads-badge.herokuapp.com/semantic_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/semantic_views_generator.svg)](https://badge.fury.io/rb/semantic_views_generator)
+
+This gem is used for generating semantic 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) gem, but for those who prefer to use Semantic UI.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'semantic_ui_views_generator', group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install semantic_ui_views_generator
+
+## Usage
+
+```shell
+Usage:
+  rails g semantic:install [options]
+
+Options:
+Options:
+-t, [--template-engine=TEMPLATE_ENGINE]     # Indicates when to generate template engine
+                                            # Default: erb
+--simpleform                                # Indicates if simpleform will be used (when used will generate a Semantic Ui based simple_form initialzer)
+                                            # 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 metatags gem function for the page title
+                                            # 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 semantic:install --template_engine=haml
+```
+
+**Slim**
+Make sure you have Slim added to your Gemfile
+```ruby
+gem 'slim-rails'
+
+# generate Slim views
+rails g semantic:install --template_engine=slim
+```
+
+#### Pagination
+
+Ensure you have [Pagy](https://github.com/ddnexus/pagy) gem installed
+```ruby
+gem 'pagy'
+```
+
+
+#### Meta-Tags
+Ensure you have the [meta-tags](https://github.com/kpumuk/meta-tags) gem installed
+```ruby
+gem 'meta-tags'
+```
+
+### Examples
+
+Generate semantic views with pagination enabled
+```shell
+rails g semantic:install --pagination
+```
+
+Generate semantic views with slim and using simple_form
+```shell
+rails g semantic:install --template_engine=slim --simpleform
+```
+
+### 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/initialzers/simple_form.rb` file for your simple_form formatting.

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "semantic_ui_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

data/lib/generators/semantic/install_generator.rb

@@ -0,0 +1,67 @@
+require 'rails/generators'
+
+module Semantic
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Overwrite Rails scaffold templates with Semantic UI based templates'
+      source_root ::File.expand_path('../templates', __FILE__)
+
+      class_option :template_engine, type: :string, default: 'erb', aliases: '-t', desc: 'Set template engine to generate the views with'
+      # Boolean flags that can be flagged by adding to the generator call ie: --pagination or --metag_tags
+      class_option :metatags, type: :boolean, default: false, aliases: "-m", desc: 'If views will assign pages title using metatags gem'
+      class_option :pagination, type: :boolean, default: false, aliases: '-p', desc: 'Toggle if pagination will be used with the index view/controller (based off of Pagy)'
+      class_option :simpleform, type: :boolean, default: false, aliases: '-sf', desc: 'Enable SimpleForms for the form generating'
+
+      def copy_scaffold_views
+        %w[edit index show new].each do |file|
+          template "scaffolds/#{options[:template_engine]}/#{file}.html.#{options[:template_engine]}", "lib/templates/#{options[:template_engine]}/scaffold/#{file}.html.#{options[:template_engine]}", force: true
+        end
+        copy_file "scaffolds/#{options[:template_engine]}/_form.html.#{options[:template_engine]}", "lib/templates/#{options[:template_engine]}/scaffold/_form.html.#{options[:template_engine]}", force: true
+      end
+
+      def create_layout
+        template "layouts/application.html.#{options[:template_engine]}.tt", "app/views/layouts/application.html.#{options[:template_engine]}", force: true
+      end
+
+      def copy_flash_messages
+        copy_file 'shared/_messages.html.erb', 'app/views/shared/_messages.html.erb', force: true
+      end
+
+      def copy_shared_pagination
+        if options[:pagination]
+          copy_file "shared/_pagination.html.#{options[:template_engine]}", "app/views/shared/_pagination.html.#{options[:template_engine]}", force: true
+        end
+      end
+
+      def copy_simpleforms
+        if options[:simpleform]
+          copy_file 'initialzers/simple_form.rb', 'config/initialzers/simple_form.rb', force: true
+
+          copy_file "simple_form/_form.html.#{options[:template_engine]}", "lib/templates/#{options[:template_engine]}/scaffold/_form.html.#{options[:template_engine]}", force: true
+        end
+      end
+
+      def inject_helpers
+        helper_str = <<-HELPER
+
+  # For generating SemanitcUI based flash[:notices]
+  def flash_class(level)
+    case level
+    when 'success'
+      'positive'
+    when 'error'
+      'negative'
+    when 'alert'
+      'negative'
+    when 'notice'
+      'info'
+    else
+      'info'
+    end
+  end
+HELPER
+        inject_into_file 'app/helpers/application_helper.rb', helper_str, after: "module ApplicationHelper\n", force: true
+      end
+    end
+  end
+end

data/lib/generators/semantic/templates/initializers/simple_form.rb

@@ -0,0 +1,223 @@
+## src: https://pranavsingh.me/semantic-ui-simple-form-wrapper/
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input, hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    # and/or database column lengths
+    b.optional :maxlength
+
+    # Calculate minlength from length validations for string inputs
+    b.optional :minlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # Custom Semantic Wrapper
+  # Values are similar to the default wrapper above, with different classes
+  config.wrappers :semantic, tag: 'div', class: "field", error_class: 'error', hint_class: 'with_hint' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
+    b.use :error, wrap_with: { tag: 'div', class: 'ui red pointing above label error' }
+  end
+
+  config.wrappers :ui_checkbox, tag: 'div', class: "field", error_class: 'error', hint_class: 'with_hint' do |b|
+    b.use :html5
+    b.wrapper tag: 'div', class: 'ui checkbox' do |input|
+      input.use :label_input
+      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
+    end
+  end
+
+  config.wrappers :ui_slider_checkbox, tag: 'div', class: "field", error_class: 'error', hint_class: 'with_hint' do |b|
+    b.use :html5
+    b.wrapper tag: 'div', class: 'ui slider checkbox' do |input|
+      input.use :label_input
+      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
+    end
+  end
+
+  config.wrappers :ui_toggle_checkbox, tag: 'div', class: "field", error_class: 'error', hint_class: 'with_hint' do |b|
+    b.use :html5
+    b.wrapper tag: 'div', class: 'ui toggle checkbox' do |input|
+      input.use :label_input
+      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
+    end
+  end
+
+  config.wrappers :ui_left_labled_input, tag: 'div', class: "field", error_class: 'error', hint_class: 'with_hint' do |b|
+    b.use :html5
+    b.use :label
+
+    b.wrapper tag: 'div', class: 'ui left labeled input' do |input|
+      input.use :input
+      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
+    end
+  end
+
+  config.wrappers :ui_right_labled_input, tag: 'div', class: "field", error_class: 'error', hint_class: 'with_hint' do |b|
+    b.use :html5
+    b.use :label
+
+    b.wrapper tag: 'div', class: 'ui right labeled input' do |input|
+      input.use :input
+      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
+    end
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  # config.default_wrapper = :default
+  config.default_wrapper = :semantic
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for semanticui config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :inline
+
+  # Default class for buttons
+  config.button_class = 'ui primary submit button'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'alert alert-error'
+
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = :div
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = "field"
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a label.
+  config.item_wrapper_tag = :div
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  config.item_wrapper_class = 'ui checkbox'
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
+  config.label_text = lambda { |label, required, explicit_label| "#{label}" }
+  # Semantic UI has its own astrick
+
+  # You can define the class to use on all labels. Default is nil.
+  # config.label_class = nil
+
+  # You can define the class to use on all forms. Default is simple_form.
+  config.default_form_class = 'ui form'
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+
+  # Define the default class of the input wrapper of the boolean input.
+  config.boolean_label_class = 'checkbox'
+
+  # Defines if the default input wrapper class should be included in radio
+  # collection wrappers.
+  # config.include_default_input_wrapper_class = true
+
+  # Defines which i18n scope will be used in Simple Form.
+  # config.i18n_scope = 'simple_form'
+end