orthodox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2ce9bc422482cca45788e382a1a63f52a14c2aabe8507419a0329a60897fea5
+  data.tar.gz: '048c63b3e2a6cda46cdc7ecc327ee6d4eceff0eff1ad92a2f83310cacb942c23'
+SHA512:
+  metadata.gz: f2e544483ac290d1491c41f713bea534a71653718b8a0ac2fe66b83004d47a28659b695e0afb283fdf74d25dbfb0867f52065dd7844b2428554d353a5e855173
+  data.tar.gz: c0691cbd280d8c5d9417025e02ef50fb5fbd9faad8c362f0746ce541b736bf05c0e07f4247d3e17027311ba7d88f7e5de7f2c1ce6b1806fc22c389a3239fe2d2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in orthodox.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bodacious
+
+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,171 @@
+# Orthodox
+
+Replacement Rails generators for Katana apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orthodox', github: "katanacode/orthodox"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orthodox
+
+## Usage
+
+### An empty controller:
+
+    rails g controller users
+
+Creates:
+
+    class Users < ApplicationController
+
+    end
+
+
+### A controller with prepopulated actions:
+
+    rails g controller users new create show
+
+Creates:
+
+    class Users < ApplicationController
+
+      def new
+        @user = users_scope.new
+      end
+
+      def create
+        @user = users_scope.new(user_params)
+        if @user.save
+          redirect_to(user_url(@user), notice: "Successfully created user")
+        else
+          render :new
+        end
+      end
+
+      def show
+        @user = users_scope.find(params[:id])
+      end
+
+
+      private
+
+
+      def users_scope
+        User.all
+      end
+
+      def user_params
+        params.require(:user).permit()
+      end
+
+    end
+
+### A controller with actions and authentication:
+
+    rails g controller users new create show --authenticate admin
+    
+Creates:
+
+    class Users < ApplicationController
+
+      before_action :authenticate_admin!
+
+
+      def new
+        @user = users_scope.new
+      end
+
+      def create
+        @user = users_scope.new(user_params)
+        if @user.save
+          redirect_to(user_url(@user), notice: "Successfully created user")
+        else
+          render :new
+        end
+      end
+
+      def show
+        @user = users_scope.find(params[:id])
+      end
+
+
+
+
+      private
+
+
+      def users_scope
+        User.all
+      end
+
+      def user_params
+        params.require(:user).permit()
+      end
+
+    end
+
+### A controller with a namespace:
+
+    rails g controller admins/users new create show --authenticate admin
+
+Creates:
+
+    class Admins::Users < Admins::BaseControler
+
+      before_action :authenticate_admin!
+
+
+      def new
+        @user = users_scope.new
+      end
+
+      def create
+        @user = users_scope.new(user_params)
+        if @user.save
+          redirect_to(user_url(@user), notice: "Successfully created user")
+        else
+          render :new
+        end
+      end
+
+      def show
+        @user = users_scope.find(params[:id])
+      end
+
+
+      private
+
+
+      def users_scope
+        User.all
+      end
+
+      def user_params
+        params.require(:user).permit()
+      end
+
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KatanaCode/orthodox.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,11 @@
+Description:
+    Replaces the Rails default controller generator with a cleaner, controller. Includes non-template actions, authentication, and SLIM templates
+
+Example:
+    rails generate controller users new create show index --authenticate admin
+
+    This will create:
+      app/controllers/users_controller.rb
+      app/views/users/new.html.slim
+      app/views/users/show.html.slim
+      app/views/users/index.html.slim

data/lib/generators/coffeescript/coffeescript_generator.rb

@@ -0,0 +1,79 @@
+require 'rails/generators'
+
+
+class CoffeescriptGenerator < Rails::Generators::NamedBase
+
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "This generator creates a coffee script file at app/assets/javascripts/partials"
+
+  argument :functions, type: :array, default: [], banner: "functionOne functionTwo"
+
+
+  attr_reader :namespace
+
+
+  def copy_template_file
+    @namespace = class_name.split("::")
+    @namespace.pop
+    @namespace = @namespace.join("::")
+    template "coffeescript.coffee.erb", file_path
+  end
+
+
+  private
+
+
+
+  def function_name
+    file_name.camelize(:lower)
+  end
+
+
+
+  def partial_file_name
+    "_#{file_name}"
+  end
+
+
+
+  def file_path
+    Rails.root.join("app/assets/javascripts/partials", partial_file_name + ".coffee")
+  end
+
+
+
+  def template_file_path(temp_name)
+    Rails.root.join('app', 'views', namespace_path + file_name, temp_name + ".html.slim")
+  end
+
+
+
+  def namespace_path
+    if namespace.blank?
+      return ""
+    else
+      namespace.split("::").map(&:underscore).join("/") + "/"
+    end
+  end
+
+
+
+  def singular_name
+    super.singularize
+  end
+
+
+
+  # def authenticate_actor?
+  #   options['authenticate'].present?
+  # end
+
+
+
+  # def authenticate_actor
+  #   options['authenticate']
+  # end
+
+end

data/lib/generators/coffeescript/templates/coffeescript.coffee.erb

@@ -0,0 +1,14 @@
+<%= function_name %> = (->
+
+  init = ->
+    # Write your code here...
+
+  <%- functions.each do |functionName| %>
+  <%= functionName %> = ->
+    # Write your function here...
+  <%- end -%>
+
+  return { init }
+)()
+
+$(document).on "turbolinks:load", <%= function_name %>.init

data/lib/generators/controller/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Replaces the Rails default controller generator with a cleaner, controller. Includes non-template actions, authentication, and SLIM templates
+
+Example:
+    rails generate controller users new create show index --authenticate admin
+
+    This will create:
+      app/controllers/users_controller.rb
+      app/views/users/new.html.slim
+      app/views/users/show.html.slim
+      app/views/users/index.html.slim

data/lib/generators/controller/controller_generator.rb

@@ -0,0 +1,80 @@
+require 'rails/generators'
+
+
+class ControllerGenerator < Rails::Generators::NamedBase
+
+  check_class_collision suffix: "Controller"
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "This generator creates an initializer file at config/initializers"
+
+  argument :actions, type: :array, default: [], banner: "action action"
+
+  class_option :authenticate, type: :string, default: nil
+
+  NON_TEMPLATE_ACTIONS = %w[create update destroy]
+
+  attr_reader :namespace
+
+
+  def copy_template_file
+    @namespace = class_name.split("::")
+    @namespace.pop
+    @namespace = @namespace.join("::")
+    template "controller.rb.erb", file_path
+    (actions - NON_TEMPLATE_ACTIONS).each do |temp_name|
+      template "view.html.slim", template_file_path(temp_name)
+    end
+  end
+
+
+  private
+
+
+  def create_flash_message
+    "Successfully created #{singular_name}"
+  end
+
+  def update_flash_message
+    "Successfully updated #{singular_name}"
+  end
+
+  def destroy_flash_message
+    "Successfully destroyed #{singular_name}"
+  end
+
+
+  def file_path
+    Rails.root.join('app', 'controllers', namespace_path + file_name + "_controller.rb")
+  end
+
+  def template_file_path(temp_name)
+    Rails.root.join('app', 'views', namespace_path + file_name, temp_name + ".html.slim")
+  end
+
+  def namespace_path
+    if namespace.blank?
+      return ""
+    else
+      namespace.split("::").map(&:underscore).join("/") + "/"
+    end
+  end
+
+  def singular_name
+    super.singularize
+  end
+
+  def parent_class_name
+    namespace.blank? ? 'ApplicationController' : namespace  + "::BaseController"
+  end
+
+  def authenticate_actor?
+    options['authenticate'].present?
+  end
+
+  def authenticate_actor
+    options['authenticate']
+  end
+
+end

data/lib/generators/controller/templates/controller.rb.erb

@@ -0,0 +1,74 @@
+class <%= class_name %>Controller < <%= parent_class_name %>
+
+  <%- if authenticate_actor? -%>
+  before_action :authenticate_<%= authenticate_actor %>!
+  <%- end -%>
+
+  <%- if actions.include?('index') -%>
+  def index
+    @<%= plural_name %> = <%= plural_name %>_scope
+  end
+  <%- end -%>
+
+  <%- if actions.include?('new') -%>
+  def new
+    @<%= singular_name %> = <%= plural_name %>_scope.new
+  end
+  <%- end -%>
+
+  <%- if actions.include?('create') -%>
+  def create
+    @<%= singular_name %> = <%= plural_name %>_scope.new(<%= singular_name %>_params)
+    if @<%= singular_name %>.save
+      redirect_to(<%= singular_name %>_url(@<%= singular_name %>), notice: "<%= create_flash_message %>")
+    else
+      render :new
+    end
+  end
+  <%- end -%>
+
+  <%- if actions.include?('show') -%>
+  def show
+    @<%= singular_name %> = <%= plural_name %>_scope.find(params[:id])
+  end
+  <%- end -%>
+
+  <%- if actions.include?('edit') -%>
+  def edit
+    @<%= singular_name %> = <%= plural_name %>_scope.find(params[:id])
+  end
+  <%- end -%>
+
+  <%- if actions.include?('update') -%>
+  def update
+    @<%= singular_name %> = <%= plural_name %>_scope.find(params[:id])
+    if @<%= singular_name %>.update(<%= singular_name %>_params)
+      redirect_to(<%= singular_name %>_url(@<%= singular_name %>), notice: "<%= update_flash_message %>")
+    else
+      render :edit
+    end
+  end
+  <%- end -%>
+
+  <%- if actions.include?('destroy') -%>
+  def destroy
+    @<%= singular_name %> = <%= plural_name %>_scope.find(params[:id])
+    @<%= singular_name %>.destroy
+    redirect_to(<%= singular_name %>_url(@<%= singular_name %>), notice: "<%= destroy_flash_message %>")
+  end
+  <%- end -%>
+
+  <%- if actions.any? -%>
+  private
+
+
+  def <%= plural_name %>_scope
+    <%= singular_name.classify %>.all
+  end
+
+  def <%= singular_name %>_params
+    params.require(:<%= singular_name %>).permit()
+  end
+  <%- end -%>
+
+end

data/lib/generators/controller/templates/view.html.slim

@@ -0,0 +1,5 @@
+- title
+
+h1 Edit me
+
+p Lorem ipsum...

data/lib/generators/sass/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Replaces the Rails default controller generator with a cleaner, controller. Includes non-template actions, authentication, and SLIM templates
+
+Example:
+    rails generate controller users new create show index --authenticate admin
+
+    This will create:
+      app/controllers/users_controller.rb
+      app/views/users/new.html.slim
+      app/views/users/show.html.slim
+      app/views/users/index.html.slim

data/lib/generators/sass/sass_generator.rb

@@ -0,0 +1,61 @@
+require 'rails/generators'
+
+
+class SassGenerator < Rails::Generators::NamedBase
+
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "This generator creates a coffee script file at app/assets/stylesheets/partials"
+
+  argument :elements, type: :array, default: [], banner: "element element"
+
+
+  attr_reader :namespace
+
+
+  def copy_template_file
+    @namespace = class_name.split("::")
+    @namespace.pop
+    @namespace = @namespace.join("::")
+    template "sass.sass.erb", file_path
+  end
+
+
+  private
+
+
+
+  def block_name
+    file_name.underscore
+  end
+
+
+
+  def partial_file_name
+    "_#{file_name}"
+  end
+
+
+
+  def file_path
+    Rails.root.join("app/assets/stylesheets/partials", partial_file_name + ".sass")
+  end
+
+
+
+  def namespace_path
+    if namespace.blank?
+      return ""
+    else
+      namespace.split("::").map(&:underscore).join("/") + "/"
+    end
+  end
+
+
+
+  def singular_name
+    super.singularize
+  end
+
+end

data/lib/generators/sass/templates/sass.sass.erb

@@ -0,0 +1,8 @@
+.<%= block_name %>
+  // Define <%= block_name %> block here
+
+<%- for element in elements -%>
+.<%= block_name %>__<%= element %>
+  // Define <%= element %> element here
+
+<%- end -%>

data/lib/orthodox.rb

@@ -0,0 +1,5 @@
+require "orthodox/version"
+require 'orthodox/railtie'
+module Orthodox
+
+end

data/lib/orthodox/railtie.rb

@@ -0,0 +1,12 @@
+require 'orthodox'
+require 'rails'
+
+module Orthodox
+  class Railtie < Rails::Railtie
+
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../generators', __FILE__)
+    end
+
+  end
+end

data/lib/orthodox/version.rb

@@ -0,0 +1,3 @@
+module Orthodox
+  VERSION = "0.1.0"
+end

data/orthodox.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "orthodox/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "orthodox"
+  spec.version       = Orthodox::VERSION
+  spec.authors       = ["Bodacious", 'CodeMeister']
+  spec.email         = ["team@katanacode.com"]
+
+  spec.summary       = %q{Better Rails generators for Katana}
+  spec.description   = %q{Replaces Rails generators with generators specific to Katana's workflow'}
+  spec.homepage      = "https://github.com/KatanaCode/orthodox"
+  spec.license       = "MIT"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", 'lib/generators']
+  spec.add_dependency 'rails', '>= 3.0.0'
+  spec.add_dependency 'slim-rails'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: orthodox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bodacious
+- CodeMeister
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: slim-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Replaces Rails generators with generators specific to Katana's workflow'
+email:
+- team@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/coffeescript/USAGE
+- lib/generators/coffeescript/coffeescript_generator.rb
+- lib/generators/coffeescript/templates/coffeescript.coffee.erb
+- lib/generators/controller/USAGE
+- lib/generators/controller/controller_generator.rb
+- lib/generators/controller/templates/controller.rb.erb
+- lib/generators/controller/templates/view.html.slim
+- lib/generators/sass/USAGE
+- lib/generators/sass/sass_generator.rb
+- lib/generators/sass/templates/sass.sass.erb
+- lib/orthodox.rb
+- lib/orthodox/railtie.rb
+- lib/orthodox/version.rb
+- orthodox.gemspec
+homepage: https://github.com/KatanaCode/orthodox
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/generators
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.1
+signing_key: 
+specification_version: 4
+summary: Better Rails generators for Katana
+test_files: []