rails_namespace_engine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea1ba95da16e9ea926b0a3599bb628a77dc859a5
+  data.tar.gz: ea97a8ca3aab52fc3bb1c577c4c9cb466f75ba08
+SHA512:
+  metadata.gz: 48e0ed14d1f04ad03fb38476ebacc7351cf50dc5909364e608dd4e73dccabb05f1732cb7bf0f9c1f12569a23efd0f500df7b5c07b8ee41e5389de0a3d115141d
+  data.tar.gz: b3ff6171153b3c4ff4024e217a74709831f5e35d133d06a0f5e12082b0ad398c512a386ddd69c3264a56af80527840e16a5b8c1a75a3aaa78bf6a8aca17c683d

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 dukeoflaser@gmail.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_namespace_engine.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,41 @@
+# RailsNamespaceEngine
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_namespace_engine`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_namespace_engine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_namespace_engine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/nathaniel-miller/rails_namespace_engine. 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](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 "rails_namespace_engine"
+
+# 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/namespace_engine

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/rails_namespace_engine.rb'
+
+NamespaceEngine.new(ARGV).call

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/rails_namespace_engine/version.rb

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

data/lib/rails_namespace_engine.rb

@@ -0,0 +1,212 @@
+require 'fileutils'
+require 'rails/generators'
+require_relative "rails_namespace_engine/version"
+
+class NamespaceEngine
+  attr_reader :help, :namespace, :engine_name
+
+  def initialize(argv)
+    argv[0] = '--help' if argv.size < 2
+
+    if argv[0] == '--help'
+      @help = true
+    else
+      @help = false
+      @namespace = argv[0].underscore
+      @engine_name = argv[1].underscore
+    end
+  end
+
+  def call
+    if help
+      puts instructions
+    else
+      invoke_generator
+      structure_files_and_directories
+      file_contents
+    end
+  end
+
+  private
+
+  def instructions
+    insts = <<-INSTS
+      Simply provide two arguments.
+      The first is the name of the namespace you wish to use.
+      The second is the name used for the generated engine.
+
+      Ex. rne my_namespace my_engine.
+
+      This script will run 'rails plugin new engine_name --mountable'.
+      It then uses the provided namespace argument to restructure the file
+      directory and alter the appropriate files.
+
+      The precise nature of these alterations can be viewed in this gems README
+      file or at 'http://m.ller.io/namespacing-for-rails-engines/'.
+    INSTS
+
+    insts
+  end
+
+  def invoke_generator
+    Rails::Generators.invoke('plugin', [engine_name, '--mountable'])
+    FileUtils.cd('../../../')
+  end
+
+  def structure_files_and_directories
+    @root = "./engines/#{engine_name}"
+    @path_one = "#{@root}/lib/#{namespace}"
+    @path_two = "#{@root}/lib/#{engine_name}"
+
+
+    FileUtils.mkdir './engines' unless Dir.exists?('./engines')
+    FileUtils.mv "#{engine_name}", './engines'
+    FileUtils.mkdir @path_one
+    FileUtils.mv @path_two, @path_one
+    FileUtils.mv "#{@path_two}.rb", @path_one
+    FileUtils.touch "#{@path_one}_#{engine_name}.rb"
+    FileUtils.mv "#{@root}/#{engine_name}.gemspec",
+      "#{@root}/#{namespace}_#{engine_name}.gemspec"
+  end
+
+  def file_contents
+    @files = []
+    7.times { @files << Hash.new }
+
+    file_0
+    file_1
+    file_2
+    file_3
+    file_4
+    file_5
+    file_6
+
+    add_gem_to_gemfile
+    config_routes
+    write_to(@files)
+    puts success
+  end
+
+  def file_0
+    @files[0][:file] = "#{@path_one}_#{engine_name}.rb"
+    @files[0][:contents] = <<-EOF.strip_heredoc
+      require "#{namespace}/#{engine_name}/engine"
+      require "#{namespace}/#{engine_name}"
+    EOF
+  end
+
+  def file_1
+    @files[1][:file] = "#{@path_one}/#{engine_name}.rb"
+    @files[1][:contents] = <<-EOF.strip_heredoc
+      module #{namespace.camelize}
+        module #{engine_name.camelize}
+          # Your code goes here...
+        end
+      end
+    EOF
+  end
+
+  def file_2
+    @files[2][:file] = "#{@path_one}/#{engine_name}/version.rb"
+    @files[2][:contents] = <<-EOF.strip_heredoc
+      module #{namespace.camelize}
+        module #{engine_name.camelize}
+          VERSION = '0.1.0'
+        end
+      end
+    EOF
+  end
+
+  def file_3
+    @files[3][:file] = "#{@path_one}/#{engine_name}/engine.rb"
+    @files[3][:contents] = <<-EOF.strip_heredoc
+      module #{namespace.camelize}
+        module #{engine_name.camelize}
+          class Engine < ::Rails::Engine
+            isolate_namespace #{namespace.camelize}
+          end
+        end
+      end
+    EOF
+  end
+
+  def file_4
+    @files[4][:file] = "#{@root}/#{namespace}_#{engine_name}.gemspec"
+    contents = File.read(@files[4][:file])
+
+    patterns = [{},{},{}]
+    patterns[0][:original] = %Q'#{engine_name}/version'
+    patterns[0][:update] = %Q'#{namespace}/#{engine_name}/version'
+    patterns[1][:original] = %Q'= "#{engine_name}"'
+    patterns[1][:update] = %Q'= "#{namespace}_#{engine_name}"'
+    patterns[2][:original] = %'#{engine_name.camelize}::VERSION'
+    patterns[2][:update] = %'#{namespace.camelize}::#{engine_name.camelize}::VERSION'
+
+    patterns.each do |pattern|
+      @files[4][:contents] = contents.gsub!(pattern[:original], pattern[:update])
+    end
+  end
+
+  def file_5
+    @files[5][:file] = "#{@root}/bin/rails"
+    contents = File.read(@files[5][:file])
+    old_path = "../../lib/#{engine_name}"
+    updated_path = "../../lib/#{namespace}/#{engine_name}"
+    @files[5][:contents] = contents.gsub(old_path, updated_path)
+  end
+
+  def file_6
+    @files[6][:file] = "#{@root}/config/routes.rb"
+    @files[6][:contents] = <<-EOF.strip_heredoc
+      #{namespace.camelize}::#{engine_name.camelize}::Engine.routes.draw do
+      end
+    EOF
+  end
+
+  def add_gem_to_gemfile
+    add_gem_to_gemfile = <<-GEM.strip_heredoc
+
+      #Add unpacked gem directly from file system
+      gem '#{namespace}_#{engine_name}', path: 'engines/#{engine_name}'
+    GEM
+
+    File.open('Gemfile', 'a') do |file|
+      file.write add_gem_to_gemfile
+    end
+  end
+
+  def config_routes
+    tempfile = File.open("config/routes.tmp", 'w')
+    f = File.new("config/routes.rb")
+
+    f.each do |line|
+      tempfile << line
+      if line =~ /Rails.application.routes.draw do/
+        tempfile << "  mount #{namespace.camelize}::#{engine_name.camelize}::Engine => '/#{engine_name}', as: '#{engine_name}' \n"
+      end
+    end
+
+    f.close
+    tempfile.close
+
+    FileUtils.mv("config/routes.tmp", "config/routes.rb")
+  end
+
+  def write_to(files)
+    files.each do |f|
+      File.open(f[:file], 'w') do |file|
+        file.write f[:contents]
+      end
+    end
+  end
+
+  def success
+    success = <<-SUCCESS
+
+      *** NAMESPACING SUCCESSFUL ***
+    SUCCESS
+
+    success
+  end
+
+end

data/rails_namespace_engine.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_namespace_engine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_namespace_engine"
+  spec.version       = RailsNamespaceEngine::VERSION
+  spec.authors       = ["Nathaniel Miller"]
+  spec.email         = ["nathaniel@m.ller.io"]
+
+  spec.summary       = %q{Generate a rails engine with an extra layer of namespacing.}
+  spec.description   = %q{This script runs the rails plugin generator and then changes directory structure and file contents to prevent potential collisions with other engines.}
+  spec.homepage      = "http://m.ller.io"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables << 'namespace_engine'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rails_namespace_engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathaniel Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This script runs the rails plugin generator and then changes directory
+  structure and file contents to prevent potential collisions with other engines.
+email:
+- nathaniel@m.ller.io
+executables:
+- namespace_engine
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/namespace_engine
+- bin/setup
+- lib/rails_namespace_engine.rb
+- lib/rails_namespace_engine/version.rb
+- rails_namespace_engine.gemspec
+homepage: http://m.ller.io
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generate a rails engine with an extra layer of namespacing.
+test_files: []