countries_regions_and_cities_by_pete 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6f46cb706a9aef6154eecf7809c20ef0b3829f428979b15aeacd3994023823
-  data.tar.gz: 3789e83e4c2bfcdc6da49d9d46e00a0bee1b6588bc279da69da5209941bb2d55
+  metadata.gz: 57e8bde7c5523da1f52564b022c232b4dc13728f33600e4f6a85ea1885f34b90
+  data.tar.gz: 6ba904136481ac3d88b6ecb0174c9df71e11a9672c12a50ccb7c4961a9e58606
 SHA512:
-  metadata.gz: 66b5536f6e9b28ba7299c330a9ffeabf8445a795bd4a69c07849e5b0ca2e6b2435f619669d38565079c6bf760b0ca47b55626226bebf11ee9a5f308a221cc130
-  data.tar.gz: eac164cc1b10bb6fa4c031a760ed25f85b801e34040e5aaf0f3a1e9cd2ef63589e6380708fa17782ff406f2a6f82549be851f90b470212108c4abdcfa98f74b0
+  metadata.gz: 62b5e5902d714708e7ab15582993a9b6d59918a2454bdd97dfc77d56ad1cb8bf2da64cc8f200740dbecf300e3d34f632cffbb67b18c40447ce4f44914db5269a
+  data.tar.gz: 35f1d34399bf14c6334eb22619324582f87b440b2da385d7f8d47c6a63295f7e4b9b213b7558ad20e343a73065a8ab1351c3de78ddedabce27fc44c223c52ac6

data/README.md

@@ -1,55 +1,78 @@
-# Countries Regions And Cities By Peter Consuegra
+# Ruby On Rails Countries, Regions and Cities by Pete
 
-An agile way to implement Countries, Regions and Cities in your project, without the need to create additional tables
+An agile way to implement Countries, Regions, and Cities in a Ruby On Rails scaffold without the need to create additional tables
+
+## Support
+
+Ruby On Rails: 5, 6, 7
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'countries_regions_and_cities_by_peterconsuegra', '>= 0.2.5'
+gem 'countries_regions_and_cities_by_pete'
 ```
 
 And then execute:
 
     $ bundle install
 
-Add the jquery.min.js file to the layout you are using: /app/views/layouts/application.html.erb
 
-```javascript
-<script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" crossorigin="anonymous"></script>
+## Usage
+Let's create a example for a Place scaffold:
+
+1. Let's create a new rails app:
+
+```ruby
+rails new myapp 
 ```
 
-Run the rake command to generate the necessary files:
+2. Create the database:
 
-    $ bundle exec rake 'install_countries_regions_and_cities_to_model[your_model_name]'
+```ruby
+bundle exec rake db:create
+```
 
-Allow the following trusted parameters: country, region, city in your model controller. Example:
+3. Go to the application directory in Terminal and run the following command to create a scaffold for the Place model:
 
 ```ruby
-# Example: Only allow a list of trusted parameters through.
-    def hotel_params
-      params.require(:hotel).permit(:name, :description, :address, :country, :region, :city)
-    end
+bundle exec rails g scaffold Place name:string description:text
 ```
 
-Add this code to the _form.html.erb partial of your_model_name form
+4. Go to the application directory in Terminal and run the following command to install the necessary files from the gem:
+
 
+```ruby
+bundle exec rake 'install_countries_regions_and_cities_by_pete[Place]'
 ```
 
-<div class="field" id="country_field">
-<%= render partial: 'shared/peterconsuegra_country_select', locals: {model: form.object.class.name.downcase, label: "Country", selected: form.object.country} %>
-</div>
+5. Add jQuery to your layout file: /app/views/layouts/application.html.erb
 
-<div class="field" id="region_field">
-<%= render partial: 'shared/peterconsuegra_region_select', locals: {model: form.object.class.name.downcase, label: "Region / State", selected_country: form.object.country, selected: form.object.region} %>
-</div>
+```html
+<script src='/countries_regions_and_cities_by_pete/jquery-3.6.0.min.js'></script>
+```
+
+6. Paste this code to your _form.html.erb file: /app/views/places/_form.html.erb
+```ruby
 
-<div class="field" id="city_field">
-<%= render partial: 'shared/peterconsuegra_city_select', locals: {model: form.object.class.name.downcase, label: "City", selected_region: form.object.region, selected_country: form.object.country, selected: form.object.city} %>
-</div>
+<div class="field" id="country_field">
+  <%= render partial: "shared/country_select_by_pete", locals: {model: form.object.class.name, label: "Country", selected: form.object.country} %>
+  </div>
+<div class="field" id="region_field">
+  <%= render partial: "shared/region_select_by_pete", locals: {model: form.object.class.name, label: "Region / State", selected_country: form.object.country, selected: form.object.region} %>
+  </div>
+ <div class="field" id="city_field">
+  <%= render partial: "shared/city_select_by_pete", locals: {model: form.object.class.name, label: "City", selected_region: form.object.region, selected_country: form.object.country, selected: form.object.city} %>
+  </div>
 
+```
+7. Allow parameters (country,region and city) in your controller: /app/controllers/places_controller.rb
 
+```ruby
+def place_params
+   params.require(:place).permit(:name, :description, :address, :country, :region, :city)
+end
 ```
 
 Video Tutorial
@@ -57,15 +80,12 @@ Video Tutorial
 
 Watch this video to see how it works
 
-[![IMAGE ALT TEXT HERE](https://ozonegroup.co/countries_regions_and_cities.png)](https://www.youtube.com/watch?v=VrIVdsOnJsY)
-
-
-
+[![IMAGE ALT TEXT HERE](https://ozonegroup.co/countries_regions_and_cities.png)](https://www.youtube.com/watch?v=mSwfFtYE8HE)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/peterconsuegra/countries_regions_and_cities. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/countries_regions_and_cities_by_peterconsuegra/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/peterconsuegra/countries_regions_and_cities. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/peterconsuegra/countries_regions_and_cities_by_peterconsuegra/blob/master/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the CountriesRegionsAndCitiesByPeterconsuegra project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/countries_regions_and_cities_by_peterconsuegra/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CountriesRegionsAndCitiesByPeterconsuegra project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/peterconsuegra/countries_regions_and_cities_by_peterconsuegra/blob/master/CODE_OF_CONDUCT.md).

data/lib/countries_regions_and_cities_by_pete/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CountriesRegionsAndCitiesByPete
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/peterconsuegra_recipes.rb

@@ -1,16 +1,40 @@
 require 'colorize'
-
+require 'fileutils'
+require "tty-file"
 
 module PeterConsuegraRecipes  
   
   def self.move_templates(src_folder,dest_folder,files)
+    FileUtils.mkdir_p dest_folder
     files.each do |file_name|
-      #puts "src_folder: #{src_folder} dest_folder: #{dest_folder}".blue
       FileUtils.cp(src_folder+file_name,dest_folder+file_name)
       puts "file copied to: #{dest_folder+file_name}".green
     end
   end
   
+  def self.move_template(src_folder,dest_folder,file)
+    FileUtils.mkdir_p dest_folder
+    FileUtils.cp src_folder+file,dest_folder+file
+    puts "File copied to: #{dest_folder+file}".green
+  end
+  
+  def self.add_route(base_route,action_name,method)
+    rails_app_folder = Dir.pwd 
+    route_file="#{rails_app_folder}/config/routes.rb"
+    route_code = "#{method} '/#{base_route}_#{action_name}', to: '#{base_route}##{action_name}'"
+    PeterConsuegraRecipes::append_before_last_appearance_of("end",route_code,route_file)
+    puts "Adding route: #{route_code}".blue
+  end
+  
+  def self.add_concern_to_controller(code,controller_file,controller_class)
+    rails_app_folder = Dir.pwd 
+    file="#{rails_app_folder}/app/controllers/#{controller_file}"
+    #puts "class #{controller_class} < ApplicationController"
+    #code="include FilesByPete\n"
+    TTY::File.inject_into_file file, code, after: "class #{controller_class} < ApplicationController\n"
+    puts "Adding concern to controller #{file}: #{code}".blue
+  end
+  
   def self.append_before_last_appearance_of(string,code,file)
     File.open(file, 'r+') do |file|
       lines = file.each_line.to_a
@@ -37,7 +61,7 @@ module PeterConsuegraRecipes
     hash["controller_file"] = hash["table_name"]+"_controller.rb"
     hash["controller_class"] = hash["table_name"].titleize.gsub(' ','')+"Controller"
     hash["base_route"] = hash["table_name"]
-    puts hash
+    #puts hash
     return hash
   end
   

data/lib/tasks/install_countries_regions_and_cities_by_pete.rake

@@ -12,47 +12,28 @@ task :install_countries_regions_and_cities_by_pete, [:model] do |t, args|
   #Base routes
   rails_app_folder = Dir.pwd 
   gem_folder = File.expand_path('../../../.', __FILE__)
+  src_folder="#{gem_folder}/templates/"
   
   #Get scaffold vars
   hash = PeterConsuegraRecipes::get_scaffold_vars(args[:model])
   
-  #Adding partials
-  dest_folder="#{rails_app_folder}/app/views/shared/"
-  src_folder="#{gem_folder}/templates/"
-  files=["_city_select_by_pete.html.erb","_country_select_by_pete.html.erb","_region_select_by_pete.html.erb"]
-  FileUtils.mkdir_p dest_folder
-  PeterConsuegraRecipes::move_templates(src_folder,dest_folder,files)
+  #Adding partials  
+  PeterConsuegraRecipes::move_templates(src_folder,"#{rails_app_folder}/app/views/shared/",["_city_select_by_pete.html.erb","_country_select_by_pete.html.erb","_region_select_by_pete.html.erb"])
   
   #Adding concern
-  dest_folder="#{rails_app_folder}/app/controllers/concerns/"
-  file="globalization_by_pete.rb"
-  FileUtils.mkdir_p dest_folder
-  FileUtils.cp src_folder+file,dest_folder+file
-  puts "File copied to: #{dest_folder+file}".green
-  
-  #Copy jquery-3.6.0.min.js file
-  dest_folder="#{rails_app_folder}/public/countries_regions_and_cities_by_pete/"
-  file="jquery-3.6.0.min.js"
-  FileUtils.mkdir_p dest_folder
-  FileUtils.cp src_folder+file,dest_folder+file
-  puts "File copied to: #{dest_folder+file}".green
-  
-  #Adding route to routes.rb
-  file="#{rails_app_folder}/config/routes.rb"
-  route1 = "get '/#{hash['base_route']}_get_regions', to: '#{hash['base_route']}#get_regions'"
-  route2 = "get '/#{hash['base_route']}_get_cities', to: '#{hash['base_route']}#get_cities'"
-  PeterConsuegraRecipes::append_before_last_appearance_of("end",route1,file)
-  PeterConsuegraRecipes::append_before_last_appearance_of("end",route2,file)
-  puts "Adding route: #{route1}".blue
-  puts "Adding route: #{route2}".blue
-  
-  #Adding include GlobalizationByPete in Controller
-  file="#{rails_app_folder}/app/controllers/#{hash['controller_file']}"
-  puts "class #{hash['controller_class']} < ApplicationController"
-  code="include GlobalizationByPete\n"
-  TTY::File.inject_into_file file, code, after: "class #{hash['controller_class']} < ApplicationController\n"
-  puts "Adding concern to controller #{file}: include GlobalizationByPete".blue
-  
+  PeterConsuegraRecipes::move_template(src_folder,"#{rails_app_folder}/app/controllers/concerns/","globalization_by_pete.rb")
+    
+  #Adding jQuery
+  PeterConsuegraRecipes::move_template(src_folder,"#{rails_app_folder}/public/countries_regions_and_cities_by_pete/","jquery-3.6.0.min.js")
+    
+  #Adding route to routes.rb 
+  PeterConsuegraRecipes::add_route(hash['base_route'],"get_regions","get")
+  PeterConsuegraRecipes::add_route(hash['base_route'],"get_cities","get")
+    
+  #Adding concern to controller
+  PeterConsuegraRecipes::add_concern_to_controller("include GlobalizationByPete\n",hash['controller_file'],hash['controller_class'])
+  
+  #Adding migration
   `rails generate migration AddFieldsTo#{hash['model_class']} country:string region:string city:string`
   sleep 2
   `rake db:migrate`
@@ -76,7 +57,7 @@ task :install_countries_regions_and_cities_by_pete, [:model] do |t, args|
   puts ' <div class="field" id="city_field">
   <%= render partial: "shared/city_select_by_pete", locals: {model: form.object.class.name, label: "City", selected_region: form.object.region, selected_country: form.object.country, selected: form.object.city} %>
   </div>'.red
-  puts "Allow globalization params in your controller #{hash['controller_file']}:".red
+  puts "Allow countries_regions_and_cities_by_pete globalization params in your controller #{hash['controller_file']}:".red
   puts "params.require(:#{hash['model']}).permit(:city, :region, :country)".red
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: countries_regions_and_cities_by_pete
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pedro Consuegra
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carmen
@@ -84,8 +84,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- countries_regions_and_cities_by_pete-0.1.26.gem
-- countries_regions_and_cities_by_pete-0.1.7.gem
 - countries_regions_and_cities_by_pete.gemspec
 - countries_regions_and_cities_by_peterconsuegra-0.2.5.gem
 - lib/countries_regions_and_cities_by_pete.rb