jimothy 1.0.001 → 1.0.009

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3449c2e563d203444526d05f5740d8d0b7a484a5eb88dce2362c7275e6bd4ccf
-  data.tar.gz: 976d694f3854574fba19992a6f90230be1aa0be73d1089b362b1d9b7c29d0993
+  metadata.gz: a70e66322520a834bb5c9aaf556786e3e66f4755a09366a0f632d4ee3d351d84
+  data.tar.gz: bbdb79e3e76580d55cc2e77babcd8d470f84a08d04d4c3ea78cd02b96b94ae52
 SHA512:
-  metadata.gz: 37ae2a52918aaa37e3fcf60887d8c5d4564fc364fadd9737a2c8b126bf3bf4e1abbf164657e73a2774f57ac1cbf560d50818af826cac156c51c8a5813c1ee6b4
-  data.tar.gz: 870da2ecfb8778c6be4f3b94f6494b4a5568cd8f365c1ae0b3fe532da0ab960309d2eabad44445165d1471930ac86c03d56e355e06b71e8c7e9f631927d93fb2
+  metadata.gz: 89298bf266deb16420fb28cac27f11aebd0a3f9c88518d2de0c75fc19f35bb20e59c7335605511ffbb376d9a52d9bedf0ec096ea3062425fdeae385fea4e3893
+  data.tar.gz: 124537a7e4e05ca4bf7ba3e4b08aa2eed49fe0f6a391fa968b0d624f15acd27ccc262b794c68b3502b2a44c5872d169b23d3b145fa2bd2decf6906a51cf601ce

data/README.md

@@ -1,27 +1,34 @@
 # Jimothy
-Placeholder user data from The Office
+Placeholder user data from The Office.
+Gem available at https://rubygems.org/gems/jimothy
 
 ![The office characters](https://github.com/mark-mcdermott/jimothy/blob/main/lib/jimothy/images/flonkerton.jpg)
 
 ## What This Does
 
-Quickly seed placeholder user data for your Rails toy app or prototype  app. Generate the names, emails and profile pictures of eighteen characters from The Office.
+Quickly seed placeholder user data for your Rails toy app or prototype app. Generate the names, emails and profile pictures of eighteen characters from The Office.
 
 ## Why
 
-This is 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.
+This is 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 for example, 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)
+- (If you don't have an app already) Run `rails new testapp`
+- Do `cd testapp`
 - 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.
 - Run `rails server` and open `http://127.0.0.1:3000/users` - you should see the users from The Office.
 
+![Jimothy screenshot](https://github.com/mark-mcdermott/jimothy/blob/main/lib/jimothy/images/screenshot.jpg)
+
 ## Usage (Slow, Doing Everything By Hand)
+- (If you don't have an app already) Run `rails new testapp`
+- Do `cd testapp`
 - 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:
+- 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

data/lib/generators/jimothy/install_generator.rb

@@ -4,21 +4,30 @@ 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)
+      def install_jimothy
+        # only run if User model doesn't exist yet
+        if !Dir[Rails.root + 'app/models/*.rb'].map { |path| path.split('/')[-1] }.include? 'user.rb'
+          # scaffold users
+          %x(rails g scaffold user name email image)
+          %x(rails db:migrate)
+        
+          # add image tag
+          gsub_file 'app/views/users/_user.html.erb',/<%= user.image %>/,'<%= image_tag user.image %>'
+        
+          # 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/,'.'
+        
+          # add jimothy call
+          seeds_file = File.read('db/seeds.rb')
+          if seeds_file == '.' # only paste in this Jimothy::seed_users if the previous empty_seed_file was successful (ie, don't add it again if it's already there)
+            gsub_file 'db/seeds.rb',/./,"require \"jimothy\"\nJimothy::seed_users"
+          end
+        
+          # seed_users
+          %x(rails db:seed)
+        else 
+          puts "Error: user model already exists. Skipping jimothy install."
+        end
       end
     end
   end

data/lib/jimothy/version.rb

@@ -1,3 +1,3 @@
 module Jimothy
-  VERSION = "1.0.001"
+  VERSION = "1.0.009"
 end

data/lib/jimothy.rb

@@ -33,7 +33,7 @@ module Jimothy
   end
 
   def self.import_images
-    images = Dir["#{GEM_IMAGE_PATH}" + "*.png"]
+    images = Dir["#{GEM_IMAGE_PATH}" + "*.png"] # TODO: there are jpgs in this folder for the readme, move them to a different folder
     images.each do |path|
       image = path.split('/')[-1]
       source = "#{GEM_IMAGE_PATH}" + image 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jimothy
 version: !ruby/object:Gem::Version
-  version: 1.0.001
+  version: 1.0.009
 platform: ruby
 authors:
 - Mark McDermott
@@ -64,6 +64,7 @@ files:
 - lib/jimothy/images/pam-beesly.png
 - lib/jimothy/images/phyllis-vance.png
 - lib/jimothy/images/ryan-howard.png
+- lib/jimothy/images/screenshot.jpg
 - lib/jimothy/images/stanley-hudson.png
 - lib/jimothy/images/toby-flenderson.png
 - lib/jimothy/the-office-characters.json