superpowers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a51fe4c3133c24cd4677563044b1efa08aa25aac28c78e6cf13b44960dda5df3
+  data.tar.gz: d2231c5394e5c0cd100e74a1a27d326e76874648ab8076f7d752070d832de35f
+SHA512:
+  metadata.gz: e820e34fe9f7a9e4b8d3b927d6de00b23b52db8dd5a1e94b4a30ae14362ca56b6b0c4b410a4df08207b6a194f0250f70fed7a33133ad2f68c0fee597a4185d51
+  data.tar.gz: d7c8a357a203680d9dd8aef08472e9da1eaa29acb1f19e155db03ae6c0ce63d09f19a6b97c1a4f0c887c5cbb4175053ff2613faf58adc996b37a4807bfbb19ed

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hi@jespr.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in superpowers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jesper Christiansen
+
+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,62 @@
+# Superpowers
+
+Superpowers provides some generators to ease your Rails work:
+
+- generate scoped/nested scaffolds easily
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'superpowers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install superpowers
+
+## Usage
+
+### Create scoped scaffold
+
+Many apps relies on users being logged in. This scaffold will make it easy for you to create a resource that is scoped to `current_user` but the route remains un-nested:
+
+  `rails g superpowers:scaffold Project title --scope=current_user`
+
+The above command will generate a scaffold named Project, which is scoped to `current_user`. It will create a `ProjectsController` where every ActiveRecord reference to `project`
+is scoped like so `current_user.projects`.
+
+### Create scoped scaffold with nested routes
+
+  `rails g superpowers:scaffold Task name --scope=project --nested_route`
+
+This command will create a scaffold scoped to `Project` and nested under the `resources :projects` route. It will create a `TasksController` where task is scoped to Project like so
+`@project.tasks` - it also inserts a `before_action :set_project` which will look up the project: `@project = Project.find(params[:project_id]`.
+
+## Planned Work
+
+- Make it possible to create a scaffold where the resource is scoped to `--scope` and the model declared in `--scope` is scoped to let's say `current_user`.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/jespr/superpowers. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Superpowers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jespr/superpowers/blob/master/CODE_OF_CONDUCT.md).

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 "superpowers"
+
+# 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/superpowers/scaffold/USAGE

@@ -0,0 +1,29 @@
+Description:
+
+  Generates scaffold scoped (and with nested resources if passed as an option) to your resource of choice.
+
+Examples:
+
+  Resource scoped to `current_user` with regular non-nested routes:
+  -----------------------------------------------------------------
+  rails g superpowers:scaffold Project title --scope=current_user
+
+  This will generate:
+    views
+    controller (with project scoped like so: `current_user.projects.find(...)` etc.)
+    associations (user: `has_many :projects` - project: `belongs_to :user`)
+    route (`resources :users`)
+
+
+  Resource scoped to a parent resource with nested routes:
+  -----------------------------------------------------------------
+  rails g superpowers:scaffold Task name --scope=project --nested_route
+
+  This will generate:
+    views
+    controller (with task scoped like so: `@project.tasks.find(...)` and a `before_action :set_project`)
+    associations (project: `has_many :tasks` - task: `belongs_to :project`)
+    nested route:
+      resources :projects do
+        resources :tasks
+      end

data/lib/generators/superpowers/scaffold/scaffold_generator.rb

@@ -0,0 +1,124 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+require 'rails/generators/resource_helpers'
+# require 'rails/generators/active_record/migration'
+
+module Superpowers
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :orm, banner: "NAME", type: :string, required: true, desc: "ORM to generate the controller for"
+      class_option :scope, banner: "SCOPE", type: :string, desc: "Instance/model to scope for. Example: current_user or Project"
+      class_option :nested_route, type: :boolean, default: false
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      hook_for :helper, in: :rails
+
+      hook_for :assets, in: :rails
+
+      remove_hook_for :resource_route
+      # override
+      def add_resource_route
+        return if options[:actions].present?
+
+        route_config = "resources :#{file_name.pluralize}\n"
+
+        if @options[:nested_route]
+          route_config = "resources :#{plural_nested_parent_name} do\n" \
+                         "  resources :#{file_name.pluralize}\n" \
+                         "end\n"
+        end
+
+        route route_config
+
+        gsub_file 'config/routes.rb', / *resources :#{plural_nested_parent_name}\n/, ''
+      end
+
+      def initialize(args, *options) #:nodoc:
+        super
+      end
+
+      def create_controller
+        template "controller.rb", File.join('app/controllers', "#{controller_file_name}_controller.rb"), behavior: self.behavior
+      end
+
+      def scaffold_views
+        invoke "erb:scaffold", [singular_name, migration_attributes], behavior: self.behavior
+      end
+
+      def generate_model_and_insert_association
+        case self.behavior
+        when :invoke
+          invoke :model, [singular_name, migration_attributes, scoped_by_reference].flatten, behavior: :invoke
+          inject_into_file scoped_by_file_path, "\n  has_many :#{plural_name}", after: "ApplicationRecord"
+        when :revoke
+          # gsub_file doesn't work for some reason, so this is a quick temp solution
+          content = File.read(scoped_by_file_path).gsub(/\s*has_many :#{plural_name}/, '')
+          File.open(scoped_by_file_path, 'wb') { |file| file.write(content) }
+
+          invoke :model, [singular_name], behavior: :revoke
+        end
+      end
+
+      private
+
+      def migration_attributes
+        attributes.map { |a| "#{a.name}:#{a.type}" if a.type }
+      end
+
+      def scoped_by_reference
+        if scoped_arg.start_with?('current_')
+          klass = scoped_arg.gsub('current_', '')
+        end
+        [klass, ':', 'references'].join('')
+      end
+
+      def nested_parent_name
+        scoped_arg.gsub('current_', '').singularize
+      end
+
+      def plural_nested_parent_name
+        nested_parent_name.pluralize
+      end
+
+      def scoped_by_file_path
+        file_name = scoped_arg.gsub('current_', '')
+        "app/models/#{file_name}.rb"
+      end
+
+      def scoped_arg
+        if @options["scope"].start_with?('current_')
+          @options["scope"]
+        end
+      end
+
+      def scoped_class
+        scoped_arg.classify
+      end
+
+      def resource_arg
+        name.split('/').last.downcase.singularize
+      end
+
+      def resource_plural
+        resource_arg.pluralize
+      end
+
+      def nested_routes?
+        @options[:nested_route]
+      end
+
+      def scoped_resource
+        if nested_routes?
+          ["@#{nested_parent_name}", resource_plural].join('.')
+        else
+          [scoped_arg, resource_plural].join('.')
+        end
+      end
+    end
+  end
+end

data/lib/generators/superpowers/scaffold/templates/controller.rb.tt

@@ -0,0 +1,77 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+  <%- if nested_routes? -%>
+  before_action :set_<%= nested_parent_name %>, only: [:show, :edit, :update, :destroy]
+  <%- end -%>
+
+  # GET <%= route_url %>
+  def index
+    @pagy, @<%= plural_table_name %> = pagy(<%= orm_class.all(scoped_resource) %>)
+  end
+
+  # GET <%= route_url %>/1
+  def show
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(scoped_resource) %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+  end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(scoped_resource, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      redirect_to <%= redirect_resource_name %>, notice: <%= "'#{human_name} was successfully created.'" %>
+    else
+      render :new
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to <%= redirect_resource_name %>, notice: <%= "'#{human_name} was successfully updated.'" %>
+    else
+      render :edit
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(scoped_resource, "params[:id]") %>
+    end
+
+    <%- if nested_routes? -%>
+    def set_<%= nested_parent_name %>
+      @<%= nested_parent_name %> = <%= orm_class.find(nested_parent_name.classify, "params[:#{[nested_parent_name, 'id'].join('_')}]") %>
+    end
+    <%- end -%>
+
+    # Only allow a trusted parameter "white list" through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params.fetch(:<%= singular_table_name %>, {})
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/superpowers.rb

@@ -0,0 +1,6 @@
+require "superpowers/version"
+
+module Superpowers
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/superpowers/version.rb

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

data/superpowers.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "superpowers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "superpowers"
+  spec.version       = Superpowers::VERSION
+  spec.authors       = ["Jesper Christiansen"]
+  spec.email         = ["hi@jespr.com"]
+
+  spec.summary       = "Rails generators that gives you super powers"
+  spec.description   = "Useful rails generators"
+  spec.homepage      = "https://github.com/jespr/superpowers"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_runtime_dependency 'actionpack', ['>= 5.2']
+  spec.add_runtime_dependency 'railties',   ['>= 5.2']
+  spec.add_development_dependency "rails", ">= 5.2"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: superpowers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesper Christiansen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Useful rails generators
+email:
+- hi@jespr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/superpowers/scaffold/USAGE
+- lib/generators/superpowers/scaffold/scaffold_generator.rb
+- lib/generators/superpowers/scaffold/templates/controller.rb.tt
+- lib/superpowers.rb
+- lib/superpowers/version.rb
+- superpowers.gemspec
+homepage: https://github.com/jespr/superpowers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rails generators that gives you super powers
+test_files: []