firstdraft_generators 0.0.1

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 3.5.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,83 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    builder (3.2.3)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.17.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (3.5.5)
+    highline (1.7.8)
+    json (1.8.6)
+    juwelier (2.1.3)
+      builder
+      bundler (>= 1.13)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.6)
+    mime-types (2.99.3)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (2.0.1)
+    rake (12.0.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    semver (1.0.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  juwelier (~> 2.1.0)
+  rdoc (~> 3.12)
+  rspec (~> 3.5.0)
+  simplecov
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Raghu Betina
+
+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.markdown

@@ -0,0 +1,24 @@
+# firstdraft_generators
+
+This is a set of generators that help beginners learn to program. Primarily, they generate code that is more explicit and verbose and less idiomatic and “magical” than the built-in scaffold generator. It is meant to be helpful for beginners while they are still learning how things are wired together.
+
+## Contributing to firstdraft_generators
+
+ - Check out the latest master to make sure the feature hasn't been
+    implemented or the bug hasn't been fixed yet.
+ - Check out the issue tracker to make sure someone already hasn't
+    requested it and/or contributed it.
+ - Fork the project.
+    Start a feature/bugfix branch.
+    Commit and push until you are happy with your contribution.
+    Make sure to add tests for it. This is important so I don't break it
+    in a future version unintentionally.
+ - Please try not to mess with the Rakefile, version, or history. If
+    you want to have your own version, or is otherwise necessary, that
+    is fine, but please isolate to its own commit so I can cherry-pick
+    around it.
+
+## Copyright
+
+Copyright (c) 2017 Raghu Betina. See
+LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "firstdraft_generators"
+  gem.homepage = "http://github.com/raghubetina/firstdraft_generators"
+  gem.license = "MIT"
+  gem.summary = %Q{Generators that help beginners learn to program.}
+  gem.description = %Q{This is a set of generators that help beginners learn to program. Primarily, they generate code that is more explicit and verbose and less idiomatic and “magical” than the built-in scaffold generator, which is helpful for beginners while they are learning how exactly things are wired together.}
+  gem.email = "raghu@firstdraft.com"
+  gem.authors = ["Raghu Betina"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "firstdraft_generators #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/firstdraft_generators.gemspec

@@ -0,0 +1,85 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: firstdraft_generators 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "firstdraft_generators".freeze
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Raghu Betina".freeze]
+  s.date = "2017-05-08"
+  s.description = "This is a set of generators that help beginners learn to program. Primarily, they generate code that is more explicit and verbose and less idiomatic and \u{201c}magical\u{201d} than the built-in scaffold generator, which is helpful for beginners while they are learning how exactly things are wired together.".freeze
+  s.email = "raghu@firstdraft.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rubocop.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "firstdraft_generators.gemspec",
+    "lib/firstdraft_generators.rb",
+    "lib/generators/draft/layout/USAGE",
+    "lib/generators/draft/layout/layout_generator.rb",
+    "lib/generators/draft/layout/templates/_bootstrapcdn_assets.html.erb",
+    "lib/generators/draft/layout/templates/_flashes.html.erb",
+    "lib/generators/draft/layout/templates/_footer.html.erb",
+    "lib/generators/draft/layout/templates/_navbar.html.erb",
+    "lib/generators/draft/layout/templates/layout.html.erb",
+    "lib/generators/draft/model/USAGE",
+    "lib/generators/draft/model/model_generator.rb",
+    "lib/generators/draft/resource/USAGE",
+    "lib/generators/draft/resource/resource_generator.rb",
+    "lib/generators/draft/resource/templates/controllers/controller.rb",
+    "lib/generators/draft/resource/templates/controllers/read_only_controller.rb",
+    "lib/generators/draft/resource/templates/specs/crud_spec.rb",
+    "lib/generators/draft/resource/templates/specs/factories.rb",
+    "lib/generators/draft/resource/templates/views/create_row.html.erb",
+    "lib/generators/draft/resource/templates/views/destroy_row.html.erb",
+    "lib/generators/draft/resource/templates/views/edit_form.html.erb",
+    "lib/generators/draft/resource/templates/views/index.html.erb",
+    "lib/generators/draft/resource/templates/views/new_form.html.erb",
+    "lib/generators/draft/resource/templates/views/show.html.erb",
+    "lib/generators/draft/resource/templates/views/update_row.html.erb"
+  ]
+  s.homepage = "http://github.com/raghubetina/firstdraft_generators".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.11".freeze
+  s.summary = "Generators that help beginners learn to program.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.1.0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+  end
+end
+

data/lib/firstdraft_generators.rb

@@ -0,0 +1,2 @@
+module FirstdraftGenerators
+end

data/lib/generators/draft/layout/USAGE

@@ -0,0 +1,49 @@
+Description:
+
+    Generates a layout file with some handy utilities:
+
+     - Bootstrap (or a Bootswatch)
+     - Font Awesome
+     - A navbar with
+        - links to all detected index pages
+        - links to all detected registration and sign in forms
+     - Components to display flash notices and alerts
+     - A sticky footer
+
+    Specify "none" as the THEME_NAME to use vanilla Bootstrap; or, choose a
+    Bootswatch. As of this writing, available Bootswatches are:
+
+      - cerulean
+      - cosmo
+      - cyborg
+      - darkly
+      - flatly
+      - journal
+      - lumen
+      - none
+      - paper
+      - readable
+      - sandstone
+      - simplex
+      - slate
+      - spacelab
+      - superhero
+      - united
+      - yeti
+
+    WARNING: You will lose any modifications you've made to your current layout
+    if you choose to overwrite it. You can also specify a different filename
+    other than "application" with the --layout-file option.
+
+    Examples:
+
+        rails generate draft:layout
+
+        rails generate draft:layout --theme=paper
+
+        rails generate draft:layout --layout-file=some_other_filename
+
+        rails generate draft:layout --skip-cdn
+
+    (The last one omits links to CDN-hosted Bootstrap CSS, JS, and Font Awesome,
+    in case you are e.g. bundling them yourself using gems.)

data/lib/generators/draft/layout/layout_generator.rb

@@ -0,0 +1,70 @@
+module Draft
+  class LayoutGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    class_option :theme, type: :string, default: "none", desc: "Bootstrap theme"
+    class_option :layout_file, type: :string, default: "application", desc: "Layout filename"
+    class_option :skip_cdn, type: :boolean, default: false, desc: "Skip connecting CDN assets"
+
+    def generate_layout
+      if bootswatch?
+        log :insert, "Adding #{theme_name.capitalize} Bootswatch"
+      else
+        log :insert, "Adding Bootstrap"
+      end
+
+      log :insert, "Adding Font Awesome"
+      log :insert, "Adding navbar"
+      log :insert, "Adding alerts"
+      log :insert, "Adding sticky footer; you may need to add
+
+                padding-bottom: 70px
+
+              to the body of the document."
+
+      template "layout.html.erb", "app/views/layouts/#{options["layout_file"]}.html.erb"
+
+      template "_navbar.html.erb", "app/views/shared/_navbar.html.erb"
+
+      template "_flashes.html.erb", "app/views/shared/_flashes.html.erb"
+
+      template "_footer.html.erb", "app/views/shared/_footer.html.erb"
+
+      unless skip_cdn?
+        template "_bootstrapcdn_assets.html.erb", "app/views/shared/_bootstrapcdn_assets.html.erb"
+      end
+    end
+
+  protected
+
+    def bootswatch?
+      if theme_name.present?
+        theme_name != "none"
+      end
+    end
+
+    def theme_name
+      options["theme"].downcase
+    end
+
+    def skip_cdn?
+      options["skip_cdn"]
+    end
+
+    def app_resources
+      route_names.reject do |name|
+        /^rails_info.*/.match(name) || /^rails_mailers.*/.match(name) || name.pluralize != name
+      end
+    end
+
+    def devise_routes
+      route_names.map do |name|
+        /new_(.*)_registration/.match(name)
+      end.compact
+    end
+
+    def route_names
+      @route_names ||= Rails.application.routes.routes.map(&:name).uniq.compact
+    end
+  end
+end

data/lib/generators/draft/layout/templates/_bootstrapcdn_assets.html.erb

@@ -0,0 +1,9 @@
+<% if bootswatch? -%>
+<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootswatch/3.3.7/<%= theme_name %>/bootstrap.min.css">
+<% else -%>
+<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+<% end -%>
+<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
+
+<script src="//code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha256-k2WSCIexGzOj3Euiig+TlR8gA0EmPjuc79OEeY5L45g=" crossorigin="anonymous"></script>
+<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>

data/lib/generators/draft/layout/templates/_flashes.html.erb

@@ -0,0 +1,17 @@
+<div class="row">
+  <div class="col-lg-12">
+    <%% if notice.present? %>
+      <div class="alert alert-dismissable alert-success">
+        <button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button>
+        <%%= notice %>
+      </div>
+    <%% end %>
+
+    <%% if alert.present? %>
+      <div class="alert alert-dismissable alert-warning">
+        <button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button>
+        <%%= alert %>
+      </div>
+    <%% end %>
+  </div>
+</div>

data/lib/generators/draft/layout/templates/_footer.html.erb

@@ -0,0 +1,33 @@
+<nav class="navbar navbar-default navbar-fixed-bottom" role="navigation">
+  <div class="container">
+    <div class="collapse navbar-collapse" id="collapsible-nav-links">
+      <ul class="nav navbar-nav">
+        <li>
+          <a href="/about">
+            About
+          </a>
+        </li>
+
+        <li>
+          <a href="https://medium.com/">
+            Blog
+          </a>
+        </li>
+      </ul>
+
+      <ul class="nav navbar-nav navbar-right">
+        <li>
+          <a href="/contact">
+            Contact
+          </a>
+        </li>
+
+        <li>
+          <a href="/faq">
+            FAQ
+          </a>
+        </li>
+      </ul>
+    </div><!-- /.navbar-collapse -->
+  </div>
+</nav>