jimothy 1.0.002 → 1.0.011

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255502c8c568226ce82080916eae0bdb0fb3073fb7372a5f036a34616608c473
-  data.tar.gz: 73529e4e80f39edb1e56ded50686d4e6cd1d73b3f90fafe01aca155b19159f09
+  metadata.gz: d08a408d886553058d5d17a5ff41751d55de648763df93b85f6f689e57632033
+  data.tar.gz: 12c1a834d3ea3b19f948cbcc523f62f47fe7791af681bce9e920cdc1ae279c8b
 SHA512:
-  metadata.gz: 0ad498d87ab805b1a66398df1390983da77558a0339ea0753ed731601051dfd2c5459f2b3faa095987dca41e509af8b2e17225d7a9140345c5afd2aeb62a66ab
-  data.tar.gz: d9c4a066276e6ac01016030e4612645540a3583fe77500c698200e5150dca47d581237ffd7fe102986bc4da42d02583275d5b29332950ac046370a83d2a1d04b
+  metadata.gz: 74a299120ed1517dbd2c4c9518fdbef9a2e37c34579d4acbdb9444d8a787990a40f264d92377957fea34d50ec9ea7bc3e450f87d4ba40bd3c848e4309e5d8533
+  data.tar.gz: 2445363e3ca41e59ac68bd3a84d22c93a20d7638df8ebb3c6560474ad7ca1e4d30880c743326677da15bd98ef2c9cddde52bc3ddbec93dff96f9a666702fdcc6

data/README.md

@@ -1,48 +1,28 @@
 # Jimothy
-Placeholder user data from The Office.
-Gem available at https://rubygems.org/gems/jimothy
+Short description and motivation.
 
-![The office characters](https://github.com/mark-mcdermott/jimothy/blob/main/lib/jimothy/images/flonkerton.jpg)
+## Usage
+How to use my plugin.
 
-## What This Does
+## Installation
+Add this line to your application's Gemfile:
 
-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 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`
-- 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`
-- 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
+```ruby
+gem "jimothy"
 ```
-- Add the following to your `db/seeds.rb` file:
+
+And then execute:
+```bash
+$ bundle
 ```
-require "jimothy"
-Jimothy::seed_users
+
+Or install it yourself as:
+```bash
+$ gem install jimothy
 ```
-- 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` - you should see the users from The Office.
 
-## 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.
+## Contributing
+Contribution directions go here.
 
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/jimothy_manifest.js

@@ -1 +1,2 @@
 //= link_directory ../stylesheets/jimothy .css
+//= link_directory ../images

data/lib/generators/jimothy/install_generator.rb

@@ -4,21 +4,50 @@ 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
+        cyan = "\e[36m" # use cyan color for puts
+        # only run if User model doesn't exist yet
+        if !Dir[Rails.root + 'app/models/*.rb'].map { |path| path.split('/')[-1] }.include? 'user.rb'
+          puts "#{cyan}\n🦄 Scaffolding user model now."
+          # scaffold users
+          %x(rails g scaffold user name email image)
+          puts "🦄 User model/views scaffolding built."
+          %x(rails db:migrate)
+          puts "🦄 Database migrated."
+        
+          # add image tag
+          gsub_file 'app/views/users/_user.html.erb',/<%= user.image %>/,'<%= image_tag user.image %>'
+          puts "#{cyan}🦄 _user view partial updated."
+        
+          # empty seed file
+          if File.exists?('db/seeds.rb')
+            puts "🦄 Seed file exists - emptying the file now."
+            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/,''
+          else 
+            puts "🦄 Seed file does not exist. Creating now."
+            File.open("db/seeds.rb") {|f| f.write(".") }
+          end
+        
+          # add jimothy call
+          seeds_file = File.read('db/seeds.rb')
+          if seeds_file.empty? # 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)
+            puts "#{cyan}🦄 Seed file is empty - adding Jimothy::seed_users call now."
+            File.write('db/seeds.rb', "require \"jimothy\"\nJimothy::seed_users", mode: 'a+')
+          else 
+            puts "🤔 Seed file is not empty - skipping adding Jimothy::seed_users call."
+          end
+        
+          # seed users
+          puts "🦄 Seeding users now."
+          %x(rails db:seed)
+
+          # add gem manifest to app manifest
+          puts "🦄 Adding jimothy gem manifest to app manifest now.\n"
+          File.write('app/assets/config/manifest.js', '//= link jimothy_manifest.js', mode: 'a+')
+        else 
+          puts "#{cyan}\n🤔 Error: user model already exists. Skipping jimothy install."
+        end
+        puts "\e[0m" # restore puts color to normal
       end
     end
   end

data/lib/jimothy/version.rb

@@ -1,3 +1,3 @@
 module Jimothy
-  VERSION = "1.0.002"
+  VERSION = "1.0.011"
 end

data/lib/jimothy.rb

@@ -8,37 +8,28 @@ 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("#{JSON_PATH}"))['users']
   end
 
   def self.seed_users
-    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
+  # def self.seed_users
+  #   create_users
+  #   import_images
+  # end
+
+  # def self.import_images
+  #   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 
+  #     target = "#{Rails.root}#{RAILS_IMAGE_PATH}" + image
+  #     FileUtils.cp(source, target)
+  #   end
+  # end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jimothy
 version: !ruby/object:Gem::Version
-  version: 1.0.002
+  version: 1.0.011
 platform: ruby
 authors:
 - Mark McDermott
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,9 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.4.2
-description: 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.
+description: Description of Jimothy.
 email:
 - mark@markmcdermott.io
 executables: []
@@ -37,6 +35,26 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/jimothy_manifest.js
+- app/assets/images/andy-bernard.png
+- app/assets/images/angela-martin.png
+- app/assets/images/creed-bratton.png
+- app/assets/images/darryl-philbin.png
+- app/assets/images/dwight-schrute.png
+- app/assets/images/erin-hannon.png
+- app/assets/images/flonkerton.jpg
+- app/assets/images/jim-halpert.png
+- app/assets/images/kelly-kapoor.png
+- app/assets/images/kevin-malone.png
+- app/assets/images/meredith-palmer.png
+- app/assets/images/michael-scott.jpg
+- app/assets/images/michael-scott.png
+- app/assets/images/oscar-martinez.png
+- app/assets/images/pam-beesly.png
+- app/assets/images/phyllis-vance.png
+- app/assets/images/ryan-howard.png
+- app/assets/images/screenshot.jpg
+- app/assets/images/stanley-hudson.png
+- app/assets/images/toby-flenderson.png
 - app/assets/stylesheets/jimothy/application.css
 - app/controllers/jimothy/application_controller.rb
 - app/helpers/jimothy/application_helper.rb
@@ -48,29 +66,10 @@ files:
 - 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/screenshot.jpg
-- 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
-homepage: https://github.com/mark-mcdermott/jimothy/
+homepage: https://github.com/mark-mcdermott/jimothy
 licenses:
 - MIT
 metadata: {}
@@ -92,5 +91,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Placeholder Rails users from The Office
+summary: Summary of Jimothy.
 test_files: []