nyc_devshop 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,50 @@
+= NycDevshop
+
+Nyc devshop is an internal gem for the company NYC Devshop created by Yanik Jayaram which contains custom generators for the purpose of auto-generating commonly used assets, configs, gems, controllers, routes, models and views
+
+= Usage 
+In its current state, this gem should be used once and only once upon creation of your application. 
+
+couple of things to note:
+* the controllers will be set up assuming you are using rails4. 
+* the strong parameters will not be auto-filled in the controllers. You must do this yourself
+
+1. Add the following line to your gemfile:
+
+      gem 'nyc_devshop'
+
+2. Run the following command:
+  
+      $ bundle install
+
+3. Run the following command:
+  
+      $ rails g devshop_gems
+
+4. Run the following command, passing the app name (ex, 'MyApp') as an argument:
+  
+      $ rails g devshop MyApp
+
+5. Create and migrate any models for which you want CRUD actions and views to be created in your admin panel (with the exception of an Administrator model, which is automatically created for you via the generators).
+
+    e.g.
+      $ rails g model User first_name last_name email
+      $ rake db:migrate
+
+6. Run the following command, passing the names of the migrated models for which you want CRUD actions and views to be be created in your admin panel (formatting must be singular, lowercase, and space separated (*NO COMMAS*)):
+
+    e.g.
+      $ rails g devshop_admin administrator user
+
+7. Results
+  
+    * Start your rails server and you should see a dummy public index page
+    * Go to http://localhost:3000/admin to see an admin login page. Login credentials are 
+      login: 'admin@admin.com'
+     password: '123'
+     You should see your resources with associated crud actions.
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NycDevshop'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/devshop_admin_generator.rb

@@ -0,0 +1,56 @@
+class DevshopAdminGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+ #must be run AFTER creating models and migrating
+
+ #to accept multiple arguments to be used in file generation
+  argument :resources, type: :array
+
+  def create_admin_view_sub_folders
+    resources.each do |resource|
+      empty_directory "app/views/admin/#{resource.pluralize}"
+      template "_form.html.haml", "app/views/admin/#{resource.pluralize}/_form.html.haml", resource: resource
+      template "show.html.haml", "app/views/admin/#{resource.pluralize}/show.html.haml", resource: resource
+      template "edit.html.haml", "app/views/admin/#{resource.pluralize}/edit.html.haml", resource: resource
+      template "new.html.haml", "app/views/admin/#{resource.pluralize}/new.html.haml", resource: resource
+      template "index.html.haml", "app/views/admin/#{resource.pluralize}/index.html.haml", resource: resource
+    end
+  end
+
+  
+  def create_name_spaced_routes
+    #remove example code which screws up the route insert
+    gsub_file "config/routes.rb", /#   namespace :admin do/, ""
+ 
+    #add resources inside admin namespace 
+    insert_into_file "config/routes.rb", after: "namespace :admin do\n" do 
+
+      my_string = "\t\tresources " 
+
+      resources.each do |resource|
+        my_string.concat ":#{resource.pluralize}"
+        my_string.concat ", " unless resources.last == resource
+      end 
+
+      my_string.concat "\n"
+    end
+
+  end
+
+  def create_admin_layout
+    ##admin layout
+    template "admin.html.haml", "app/views/layouts/admin.html.haml"
+  end
+
+
+  def create_admin_resource_controllers
+    empty_directory "app/controllers/admin"
+    ##create admin application controller
+    template "admin_application_controller.rb", "app/controllers/admin/application_controller.rb"
+
+    #iterate over each resource, creating the controller template
+    resources.each do |resource|
+      template "controller.rb", "app/controllers/admin/#{resource.pluralize}_controller.rb", resource: resource
+    end
+  end
+end

data/lib/generators/devshop_gems_generator.rb

@@ -0,0 +1,32 @@
+class DevshopGemsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def gems_to_enable
+    #uncomment these gems
+    ["'debugger'", "'bcrypt-ruby'", "'capistrano'"].each  do |lib|
+      gsub_file 'Gemfile', /# gem #{lib}/ do |match|
+        "gem #{lib}"
+      end
+    end
+    
+    #replace sqlite3 with mysql2
+    gsub_file 'Gemfile', /gem 'sqlite3'/ do |match|
+      "gem 'mysql2'"
+    end
+
+    #add haml, simple form
+    gem 'haml-rails'
+    gem 'simple_form'
+
+
+    #add following gems to development
+    gem_group :development do 
+      gem 'letter_opener'
+      gem 'quiet_assets'
+      gem 'thin'
+    end
+
+    run "bundle install"
+  end
+
+end

data/lib/generators/devshop_generator.rb

@@ -0,0 +1,138 @@
+class DevshopGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  #to accept arguments
+  argument :app_name, type: :string
+
+  #remove files not being used or that will be replaced by our templates
+  def remove_files
+    remove_file "app/public/index.html"
+    remove_file "app/views/layouts/application.html.erb"
+    remove_file "app/assets/stylesheets/application.css"
+    remove_file "app/assets/javascripts/application.js"
+    remove_file "config/database.yml"
+    remove_file "app/helpers/application_helper.rb"
+    remove_file "db/seeds.rb"
+  end
+
+  def public_views
+    empty_directory 'app/views/public'
+    create_file 'app/views/public/index.html.haml', "this is your public index page"
+  end
+
+  def gems_to_enable
+    #uncomment these gems
+    ["'debugger'", "'bcrypt-ruby'", "'capistrano'"].each  do |lib|
+      gsub_file 'Gemfile', /# gem #{lib}/ do |match|
+        "gem #{lib}"
+      end
+    end
+    
+    #replace sqlite3 with mysql2
+    gsub_file 'Gemfile', /gem 'sqlite3'/ do |match|
+      "gem 'mysql2'"
+    end
+
+    #add haml gem
+    gem 'haml-rails'
+
+
+    #add following gems to development
+    gem_group :development do 
+      gem 'letter_opener'
+      gem 'quiet_assets'
+      gem 'thin'
+    end
+
+    run "bundle install"
+  end
+
+  def create_sql_db_yml_file
+    template "database.yml", "config/database.yml"
+    run "rake db:create"
+  end
+
+  def setup_administrator_model
+    run "rails g model Administrator email password_digest"
+    run "rake db:migrate"
+    inject_into_class "app/models/administrator.rb", Administrator do 
+      "has_secure_password\n"
+    end
+  end
+
+
+  def create_seed_file
+    template "seeds.rb", "db/seeds.rb"
+    run "rake db:seed"
+  end
+
+  def create_application_helper
+    template "application_helper.rb", "app/helpers/application_helper.rb"
+  end
+
+  def create_root_route
+    insert_into_file "config/routes.rb", after: ".draw do" do 
+      "\n\troot to: 'public#index'" 
+    end
+  end
+
+  def create_public_controller
+    template "public_controller.rb", "app/controllers/public_controller.rb"
+  end
+
+  def create_sessions_view
+    template "sessions/new.html.haml", "app/views/admin/sessions/new.html.haml"
+  end
+
+  def create_name_spaced_assets
+    #create js assets
+    template "application.js", "app/assets/javascripts/application.js"
+
+    #create css assets
+    template "normalize.css", "app/assets/stylesheets/normalize.css"
+    template "base.css.sass", "app/assets/stylesheets/base.css.sass"
+    template "application.css.sass", "app/assets/stylesheets/application.css.sass"
+
+
+    #create admin js assets
+    empty_directory "app/assets/javascripts/admin"  
+    template "bootstrap.js", "app/assets/javascripts/admin/bootstrap.js"
+    template "admin_application.js", "app/assets/javascripts/admin/application.js"
+
+    #create admin css assets
+    empty_directory "app/assets/stylesheets/admin"
+    template "bootstrap.css", "app/assets/stylesheets/admin/bootstrap.css"
+    template "admin_application.css.sass", "app/assets/stylesheets/admin/application.css.sass"
+    
+    ##application layout
+    template "application.html.haml", "app/views/layouts/application.html.haml"
+
+  end
+
+  def create_admin_sessions
+    #copy sessions controller template
+    template "sessions_controller.rb", "app/controllers/admin/sessions_controller.rb"
+  end
+
+  def create_basic_admin_routes
+    #remove example code which screws up the route insert
+    gsub_file "config/routes.rb", /#   namespace :admin do/, ""
+
+    #insert admin namespace
+    insert_into_file "config/routes.rb", after: ".draw do" do 
+      "\n\s namespace :admin do \n\tend"
+    end
+
+
+    #insert login / logout / create session routes
+    insert_into_file "config/routes.rb", after: "namespace :admin do" do 
+      "\n\t\tget 'login', to: 'sessions#new', as: :login\n\t\tget 'logout', to: 'sessions#destroy', as: :logout\n\t\tpost 'sessions', to: 'sessions#create', as: :sessions"
+    end
+
+    #insert root admin route
+    insert_into_file "config/routes.rb", after: "namespace :admin do" do 
+      "\n\t\tget '/', to: 'administrators#index', as: :root"
+    end
+
+  end
+end

data/lib/generators/templates/_form.html.haml

@@ -0,0 +1,7 @@
+= simple_form_for [:admin, @<%= config[:resource] %>] do |f|
+<%- config[:resource].classify.constantize.columns.reject {|c| !!(c.name =~ /created_at/ || c.name =~ /updated_at/ || c.name == "id")}.map {|c| [c.name, c.type]}.each do |field| -%>
+  .form-group
+    = f.input :<%= field.first.to_sym%>
+<%- end -%>
+  .form-group
+    = f.submit

data/lib/generators/templates/admin.html.haml

@@ -0,0 +1,29 @@
+!!! html5
+%html
+  %head
+    %title 
+    = stylesheet_link_tag    "admin/application", media: "all" 
+    = javascript_include_tag "admin/application" 
+    = csrf_meta_tags 
+
+  %body
+    %nav.navbar.navbar-default{role: "navigation"}
+      .navbar-inner
+        .container
+          .navbar-brand
+            =link_to 'Brand Name Here', admin_root_path
+          - if current_admin
+            %ul.nav.navbar-nav
+            <%- resources.each do |resource| -%>
+              %li= link_to <%= resource.classify %>, admin_<%= resource.downcase.pluralize %>_path
+            <%- end -%>
+            %ul.nav.navbar-nav.pull-right
+              %li= link_to 'Logout', admin_logout_path
+    .clear
+    .container
+      .main
+        = bootstrap_flash
+        = yield 
+    
+  
+

data/lib/generators/templates/admin_application.css.sass

@@ -0,0 +1,2 @@
+@import 'admin/bootstrap'
+@import 'normalize'

data/lib/generators/templates/admin_application.js

@@ -0,0 +1,4 @@
+//= require jquery
+//= require jquery_ujs
+//= require admin/bootstrap
+

data/lib/generators/templates/admin_application_controller.rb

@@ -0,0 +1,17 @@
+class Admin::ApplicationController < ApplicationController
+  layout 'admin'
+  before_filter :require_admin
+
+
+
+  def current_admin
+    @admin ||= Administrator.find_by_id(session[:admin_id])
+  end
+  helper_method :current_admin
+
+private
+  def require_admin
+    redirect_to admin_login_path unless current_admin
+  end
+
+end

data/lib/generators/templates/application.css.sass

@@ -0,0 +1,2 @@
+@import 'normalize'
+@import 'base'

data/lib/generators/templates/application.html.haml

@@ -0,0 +1,13 @@
+!!! html5
+%html
+  %head
+    %title 
+    = stylesheet_link_tag    "application", media: "all" 
+    = javascript_include_tag "application" 
+    = csrf_meta_tags 
+
+  %body
+    = yield 
+    
+  
+

data/lib/generators/templates/application.js

@@ -0,0 +1,2 @@
+//= require jquery
+//= require jquery_ujs

data/lib/generators/templates/application_controller.rb

@@ -0,0 +1,18 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  #check to see that user is logged in and assign helper
+  # def current_user
+  #   @current_user ||= User.find_by_id(session[:user_id]) if session[:user_id]
+  # end
+  # helper_method :current_user
+
+  private
+
+  #redirect user to homepage unless he's logged in
+  # def require_user
+  #   redirect_to index_path, notice: 'You must first login' unless current_user
+  # end
+
+
+end