jimothy 0.0.21 → 0.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 250781dcd85311922e16ecc05c6b52f7203164518cabb9b4777214592df06dce
-  data.tar.gz: c33365192289c9b6354314129db804b743916bd293d0e9beb8f009368302b561
+  metadata.gz: d4420439db60d5fa2d2aec818cba4c0c63b0cf6fc342b703eee0196757071ea3
+  data.tar.gz: 9facbe2f644fb523c087d5cb90815775bc127fab816c66556bd4a57ed13664c7
 SHA512:
-  metadata.gz: b24ef3f29269cdce06387f9e3c2515d8c581d891323034b4fd9ede6757bbeaf4acb0f702fc5b4cc089bbab7e867f0e61700458f708af8419dbc376e0188f28d0
-  data.tar.gz: 8c13f04464ba632d7896c25a0c552a6b4f3079f7160de28217ac29c9a420f86685688c8481db8151da93a5e57f048ea91160af384f842ebeaa4acc4be0267f82
+  metadata.gz: 9643cb22e85a3451fd998128020532c71660275a24787d03bdaa3b53ee8f58aad0d91d4ace9ae692208c9e3d158e4ddb21225242b8b37a365693491e84952172
+  data.tar.gz: 5907c72c488575a587584c83402fe01327e63e841bc781e0df48134d081320895a81a3f8bffa8bc09ecc37fc84da90a993b65c10008570b9c60a5bb880592b13

data/README.md

@@ -1,28 +1,42 @@
 # Jimothy
-Short description and motivation.
+Placeholder user data from The Office
 
-## Usage
-How to use my plugin.
+![The office characters](https://github.com/mark-mcdermott/jimothy/blob/main/lib/jimothy/images/flonkerton.jpg)
 
-## Installation
-Add this line to your application's Gemfile:
+## What This Does
 
-```ruby
-gem "jimothy"
-```
+Quickly seed amusing placeholder user data for your rails toy app or prototype  app. Generate the names, emails and profile pictures of eighteen characters from The Office.
 
-And then execute:
-```bash
-$ bundle
-```
+## Why
+
+This is obviously a (much) less robust version of something like Faker (https://github.com/faker-ruby/faker). But I built it to be more reliable than Faker, with more solid data. Faker is great for what it does, but if you generate users from TV data, sometimes users get weird names like "Skinny Pete", where "Pete" isn't really a last name and it can mess up your data. Yeah it's just placeholder data, but we want it to look right.
+
+## Usage (Quick, Using Custom Generator)
+- Add `gem "jimothy"` to your `Gemfile`
+- Run `bundle install`
+- Run `rails g jimothy:install`
+- This will scaffold user model/views, import images, seed users and add an image tag to the user view's `_user.html.erb` partial.
 
-Or install it yourself as:
-```bash
-$ gem install jimothy
+## Usage (Slow, Doing Everything By Hand)
+- Add `gem "jimothy"` to your `Gemfile`
+- Run `bundle install`
+- You'll need a `User` model with `name`, `email` and `image` fields (all `string`s. Fastest way to do this is:
+```
+rails generate scaffold User name:string email:string image:string
+rails db:migrate
+```
+- Add the following to your `db/seeds.rb` file:
+```
+require "jimothy"
+Jimothy::seed_users
 ```
+- Run `rails db:seed`
+- In `app/views/users/_user.html.erb`, change `<%= user.image %>` to `<%= image_tag user.image %>`
+- Run `rails server` and go to `http://127.0.0.1:3000/users`
 
-## Contributing
-Contribution directions go here.
+## Details
+- Main methods (`seed_users`, etc) are in `lib/jimothy.rb`
+- Initial user data is in a json file in `lib/jimothy/the-office-characters.json`
+- Inital user images are in `lib/jimothy/images`
+- I believe images in Rails engines are supposed to be directly available from the gem for use in a Rail app's asset pipeline, but I could not get this working and couldn't find sufficient documentation for this. So I just copy the images from the gem to the rails app (to `app/assets/images`) in the `import_images` method, which is called by the `seed_users` method.
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/jimothy/install_generator.rb

@@ -0,0 +1,25 @@
+require "rails/generators"
+require "rails/generators/rails/resource/resource_generator"
+
+module Jimothy
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def scaffold_users
+        %x(rails g scaffold user name email image)
+        %x(rails db:migrate)
+      end
+      def add_image_tag
+        gsub_file 'app/views/users/_user.html.erb',/<%= user.image %>/,'<%= image_tag user.image %>'
+      end
+      def empty_seed_file
+        gsub_file 'db/seeds.rb',/# This file should contain all the record creation needed to seed the database with its default values.\n# The data can then be loaded with the bin\/rails db:seed command \(or created alongside the database with db:setup\).\n#\n# Examples:\n#\n#   movies = Movie.create\(\[\{ name: \"Star Wars\" \}, \{ name: \"Lord of the Rings\" \}\]\)\n#   Character.create\(name: \"Luke\", movie: movies.first\)\n/,'.'
+      end
+      def add_jimothy_call
+        gsub_file 'db/seeds.rb',/./,"require \"jimothy\"\nJimothy::seed_users"
+      end
+      def seed_users
+        %x(rails db:seed)
+      end
+    end
+  end
+end

data/lib/jimothy/version.rb

@@ -1,3 +1,3 @@
 module Jimothy
-  VERSION = "0.0.21"
+  VERSION = "0.0.34"
 end

data/lib/jimothy.rb

@@ -3,18 +3,42 @@ require "jimothy/engine"
 require "json"
 
 GEM_ROOT = File.expand_path("../..", __FILE__)
+JSON_PATH = "#{GEM_ROOT}/lib/jimothy/the-office-characters.json"
+GEM_IMAGE_PATH = "#{GEM_ROOT}/lib/jimothy/images/"
+RAILS_IMAGE_PATH = "/app/assets/images/"
 
 module Jimothy
-  
+
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../../templates', __FILE__)
+      g.templates.unshift File::expand_path('../../templates/erb/scaffold/_user.html.erb.tt')
+      g.templates.unshift File::expand_path('../../templates/erb/scaffold/_user.html.erb')
+    end 
+  end
+
   def self.get_users
-    users = JSON.parse(IO.read("#{GEM_ROOT}/lib/jimothy/the-office-characters.json"))['users']
+    users = JSON.parse(IO.read("#{JSON_PATH}"))['users']
   end
 
   def self.seed_users
-    users = get_users
-    users.each do |user|
+    create_users
+    import_images
+  end
+
+  def self.create_users
+    get_users.each do |user|
       User.create(name: user['firstname'] + " " + user['lastname'], email: user['email'], image: user['image'])
     end
   end
 
+  def self.import_images
+    images = Dir["#{GEM_IMAGE_PATH}" + "*.png"]
+    images.each do |path|
+      image = path.split('/')[-1]
+      source = "#{GEM_IMAGE_PATH}" + image 
+      target = "#{Rails.root}#{RAILS_IMAGE_PATH}" + image
+      FileUtils.cp(source, target)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jimothy
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.34
 platform: ruby
 authors:
 - Mark McDermott
@@ -35,24 +35,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/jimothy_manifest.js
-- app/assets/images/jimothy/andy-bernard.png
-- app/assets/images/jimothy/angela-martin.png
-- app/assets/images/jimothy/creed-bratton.png
-- app/assets/images/jimothy/darryl-philbin.png
-- app/assets/images/jimothy/dwight-schrute.png
-- app/assets/images/jimothy/erin-hannon.png
-- app/assets/images/jimothy/flonkerton.jpg
-- app/assets/images/jimothy/jim-halpert.png
-- app/assets/images/jimothy/kelly-kapoor.png
-- app/assets/images/jimothy/kevin-malone.png
-- app/assets/images/jimothy/meredith-palmer.png
-- app/assets/images/jimothy/michael-scott.png
-- app/assets/images/jimothy/oscar-martinez.png
-- app/assets/images/jimothy/pam-beesly.png
-- app/assets/images/jimothy/phyllis-vance.png
-- app/assets/images/jimothy/ryan-howard.png
-- app/assets/images/jimothy/stanley-hudson.png
-- app/assets/images/jimothy/toby-flenderson.png
 - app/assets/stylesheets/jimothy/application.css
 - app/controllers/jimothy/application_controller.rb
 - app/helpers/jimothy/application_helper.rb
@@ -61,8 +43,27 @@ files:
 - app/models/jimothy/application_record.rb
 - app/views/layouts/jimothy/application.html.erb
 - config/routes.rb
+- lib/generators/jimothy/install_generator.rb
 - lib/jimothy.rb
 - lib/jimothy/engine.rb
+- lib/jimothy/images/andy-bernard.png
+- lib/jimothy/images/angela-martin.png
+- lib/jimothy/images/creed-bratton.png
+- lib/jimothy/images/darryl-philbin.png
+- lib/jimothy/images/dwight-schrute.png
+- lib/jimothy/images/erin-hannon.png
+- lib/jimothy/images/flonkerton.jpg
+- lib/jimothy/images/jim-halpert.png
+- lib/jimothy/images/kelly-kapoor.png
+- lib/jimothy/images/kevin-malone.png
+- lib/jimothy/images/meredith-palmer.png
+- lib/jimothy/images/michael-scott.png
+- lib/jimothy/images/oscar-martinez.png
+- lib/jimothy/images/pam-beesly.png
+- lib/jimothy/images/phyllis-vance.png
+- lib/jimothy/images/ryan-howard.png
+- lib/jimothy/images/stanley-hudson.png
+- lib/jimothy/images/toby-flenderson.png
 - lib/jimothy/the-office-characters.json
 - lib/jimothy/version.rb
 - lib/tasks/jimothy_tasks.rake