pilgrim 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODIwYzQ2MDdhMTcwZGIwNzlhOTRjZTg4NzBkZGQ4MDQ1OTRjNzc1ZA==
+  data.tar.gz: !binary |-
+    NWE2NmQwNzQ2MDBkM2M5MDk3Mzg1YTU4MWQyODUzNTllZWFkZDg1Yw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODVmYTk3MzY1YzU2MWFjNWJhOGU5N2JjOGIwYzIzYTgzYWY5ZTQzMjIyYmQz
+    MDhiNjE2MTQyZTk5MzlmMDZlNGZhYzE2YTE2M2UyMWQ5YmEwMzUwYTEzMDBj
+    Yjg3ZGZhZWNhYmZiYzIwMTZlMGRkOGZlZmVlNGUzYmZhNTdiY2Y=
+  data.tar.gz: !binary |-
+    NTk4MzFjN2M2ZDc4NTgyYjIyN2ZlNWUxYjM1YTlkMjcwOWM2YjhlY2JjYzY2
+    MjQ3NmVlNjlhZjQzNGI0MjdiOWVhYzBlODFjOWI3OThhMDkxMmFkNDgyYjQ2
+    OThiYmIyMTM0MTU5NDcwZTJhNzM1YTUxNjIxMjdmODllMjI1ODU=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,55 @@
+= Pilgrim
+----
+
+Choose countries, states and cities via Ajax
+
+
+=== Installation
+
+1. Add to your gemfile: <tt>gem 'pilgrim'</tt>
+2. Run <tt>bundle</tt>
+3. Execute: <tt>rails generate pilgrim:install</tt>
+4. Run migrations: <tt>rake db:migrate</tt>
+5. Run seeds: <tt>rake db:seed</tt>
+6. Add to your routes.rb: <tt>mount Pilgrim::Engine => "/pilgrim", :as => "pilgrim"</tt>
+7. Generate the views so you can configure them executing: <tt>rails generate pilgrim:generate_views</tt> (this will save the views in your_project/app/views/pilgrim)
+8. Add to your application.js: <tt>//= require pilgrim/application</tt>
+9. Watch the test/dummy for an example (watch the welcome controller and its views)
+---
+
+
+=== Use
+
+1. Add in the action where you will need to load the countries for the view: <tt>get_locations</tt>
+2. Add in your view inside of a form: <tt><%= select_location_tag :data %></tt> where "data" is the name of the form
+---
+
+
+=== Controller Methods
+<tt>get_locations</tt> gets the countries, the states of the first selected country, and the cities of the first state inside of 3 collections: @countries, @states, @cities
+---
+
+
+=== Helper Methods
+<tt>select_location_tag(form_name, params = {})</tt> display the dropdowns for the locations. This is an example of a hash for params:
+
+    
+    ...
+    params = {
+      block:  "main",
+      country:  {
+        name:  "country_field_name",
+        html_class:  "some_class"
+      },
+      state:  {
+        name:  "state_field_name",
+        html_class:  "some_class"
+      },
+      city:  {
+        name:  "city_field_name",
+        html_class:  "some_class"
+      }
+    }
+    ...
+
+Where <tt>block</tt> defines an id, so you can use the helper as many times you want changing the value in this key; the configurations for country, state and city are separated and in each one you can define the field name and the class you want to use for each element.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pilgrim'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/pilgrim/application.js

@@ -0,0 +1,43 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .
+
+$(document).ready(function(){
+	$(".locations_container").on("change", ".dropdown_location", function(e){
+		var block = $(this).attr("data-block");
+		var kind = $(this).attr("data-kind");
+		var city_id = block + "_city";
+		var data = { 
+		  	value: $(this).val(),
+		  	kind: kind,
+		  	block: block,
+		  	city_name: $("#" + city_id).attr("data-name"),
+		  	city_html_class: $("#" + city_id).attr("class"),
+		  	form_name: $(this).attr("data-formname")
+		}
+
+		if(kind == "country"){
+			var state_id = block + "_state";
+			data['state_name'] = $("#" + state_id).attr("data-name");
+		  	data['state_html_class'] = $("#" + state_id).attr("class");
+		}
+
+		$.ajax({
+		  type: "POST",
+		  url: "/pilgrim/change_location",
+		  data: data
+		});
+	});
+});

data/app/assets/javascripts/pilgrim/tags.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/pilgrim/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/pilgrim/tags.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/pilgrim/application_controller.rb

@@ -0,0 +1,5 @@
+module Pilgrim
+  class ApplicationController < ActionController::Base
+
+  end
+end

data/app/controllers/pilgrim/tags_controller.rb

@@ -0,0 +1,31 @@
+require_dependency "pilgrim/application_controller"
+
+module Pilgrim
+  class TagsController < ApplicationController
+
+	  def change_location
+	    @block = params[:block]
+	    @kind = params[:kind]
+	    @form_name = params[:form_name]
+        @city_name = params[:city_name]
+        @city_html_class = params[:city_html_class]
+	    value = params[:value]
+
+	    @states = nil
+	    @cities = nil
+
+	    if @kind == "country"
+	      @state_name = params[:state_name]
+	      @state_html_class = params[:state_html_class]
+	      
+	      country = Pilgrim::Country.find(value)
+	      @states = country.states
+	      @cities = @states.first.cities rescue []
+	    elsif @kind == "state"
+	      state = Pilgrim::State.find(value)
+	      @cities = state.cities
+	    end
+	  end
+
+  end
+end

data/app/helpers/pilgrim/application_helper.rb

@@ -0,0 +1,64 @@
+module Pilgrim
+  module ApplicationHelper
+
+  	def select_location_tag(form_name, params = {})
+  		block = params[:block].nil? ? "main" : params[:block]
+  		render :partial => "pilgrim/tags/container", :locals => { form_name: form_name, params: params, block: block }
+  	end
+
+  	def select_for_country(form_name, block, params = {})
+  		country_name = params[:country][:name] rescue "country_id"
+  		country_html_class = params[:country][:html_class] + " dropdown_location" rescue "dropdown_location"
+  		country_html_id = block + "_country"
+
+  		render  :partial => "pilgrim/tags/dropdown", 
+              :locals => { 	
+                              form_name: form_name, 
+  														name: country_name, 
+  														selected_position: 1, 
+  														kind: "country", 
+  														block: block, 
+  														html_class: country_html_class, 
+  														html_id: country_html_id,
+  														data: @countries
+  		}
+  	end
+
+  	def select_for_state(form_name, block, params = {})
+  		state_name = params[:state][:name] rescue "state_id"
+  		state_html_class = params[:state][:html_class] + " dropdown_location" rescue "dropdown_location"
+  		state_html_id = block + "_state"
+
+  		render :partial => "pilgrim/tags/dropdown", :locals => { 	form_name: form_name, 
+  																	name: state_name, 
+  																	selected_position: 1, 
+  																	kind: "state", 
+  																	block: block, 
+  																	html_class: state_html_class, 
+  																	html_id: state_html_id,
+  																	data: @states
+  		}
+  	end
+
+  	def select_for_city(form_name, block, params = {})
+  		city_name = params[:city][:name] rescue "city_id"
+  		city_html_class = params[:city][:html_class] rescue ""
+  		city_html_id = block + "_city"
+
+  		render :partial => "pilgrim/tags/dropdown", :locals => { 	form_name: form_name, 
+  																	name: city_name, 
+  																	selected_position: 1, 
+  																	kind: "city", 
+  																	block: block, 
+  																	html_class: city_html_class, 
+  																	html_id: city_html_id,
+  																	data: @cities
+  		}
+  	end
+
+  	def select_for_element_aux(form_name, name, data, selected_position, kind, block, html_class, html_id)
+  		render :partial => "pilgrim/tags/dropdown_aux", :locals => { form_name: form_name, name: name, data: data, selected_position: selected_position, :kind => kind, :block => block, :html_class => html_class, :html_id => html_id }
+  	end
+
+  end
+end

data/app/models/pilgrim/city.rb

@@ -0,0 +1,6 @@
+module Pilgrim
+  class City < ActiveRecord::Base
+    belongs_to :state
+    attr_accessible :name, :state_id
+  end
+end

data/app/models/pilgrim/country.rb

@@ -0,0 +1,10 @@
+module Pilgrim
+  class Country < ActiveRecord::Base
+    has_many :states
+    attr_accessible :code, :continent, :name, :region
+
+    def self.get_countries
+    	order("id ASC")
+    end
+  end
+end

data/app/models/pilgrim/state.rb

@@ -0,0 +1,7 @@
+module Pilgrim
+  class State < ActiveRecord::Base
+    belongs_to :country
+    has_many :cities
+    attr_accessible :name, :country_id
+  end
+end

data/app/views/layouts/pilgrim/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Pilgrim</title>
+  <%= stylesheet_link_tag    "pilgrim/application", :media => "all" %>
+  <%= javascript_include_tag "pilgrim/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/pilgrim/tags/_container.html.erb

@@ -0,0 +1,5 @@
+<div class="locations_container">
+	<%= select_for_country form_name, block, params %>
+	<%= select_for_state form_name, block, params %>
+	<%= select_for_city form_name, block, params %>
+</div>

data/app/views/pilgrim/tags/_dropdown.html.erb

@@ -0,0 +1,3 @@
+<div id="<%= "container_#{block}_#{kind}" %>">
+	<%= select_for_element_aux(form_name, name, data, selected_position, kind, block, html_class, html_id) %>
+</div>

data/app/views/pilgrim/tags/_dropdown_aux.html.erb

@@ -0,0 +1 @@
+<%= select form_name, name, options_for_select(data.collect{ |c| [c.name, c.id] }, 1), {}, :data => {:kind => kind, :block => block, :formname => form_name, :name => name}, :class => html_class, :id => html_id %>

data/app/views/pilgrim/tags/change_location.js.erb

@@ -0,0 +1,6 @@
+<% if @kind == "country" %>
+	$('#container_<%= @block %>_state').html('<%=j select_for_element_aux(@form_name, @state_name, @states, 0, "state", @block, @state_html_class, @block + "_state") %>');
+	$('#container_<%= @block %>_city').html('<%=j select_for_element_aux(@form_name, @city_name, @cities, 0, "city", @block, @city_html_class, @block + "_city") %>');
+<% elsif @kind == "state" %>
+	$('#container_<%= @block %>_city').html('<%=j select_for_element_aux(@form_name, @city_name, @cities, 0, "city", @block, @city_html_class, @block + "_city") %>');
+<% end %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Pilgrim::Engine.routes.draw do
+
+	post 'change_location' => 'tags#change_location'
+	
+end

data/db/migrate/20130430152412_create_pilgrim_countries.rb

@@ -0,0 +1,12 @@
+class CreatePilgrimCountries < ActiveRecord::Migration
+  def change
+    create_table :pilgrim_countries do |t|
+      t.string :code
+      t.string :name
+      t.string :continent
+      t.string :region
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130430152543_create_pilgrim_states.rb

@@ -0,0 +1,11 @@
+class CreatePilgrimStates < ActiveRecord::Migration
+  def change
+    create_table :pilgrim_states do |t|
+      t.references :country
+      t.string :name
+
+      t.timestamps
+    end
+    add_index :pilgrim_states, :country_id
+  end
+end

data/db/migrate/20130430152605_create_pilgrim_cities.rb

@@ -0,0 +1,11 @@
+class CreatePilgrimCities < ActiveRecord::Migration
+  def change
+    create_table :pilgrim_cities do |t|
+      t.references :state
+      t.string :name
+
+      t.timestamps
+    end
+    add_index :pilgrim_cities, :state_id
+  end
+end

data/lib/generators/pilgrim/generate_views/generate_views_generator.rb

@@ -0,0 +1,12 @@
+module Pilgrim
+  module Generators
+    class GenerateViewsGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../../../../app/views", __FILE__)
+      desc "Generate Views of Pilgrim"
+
+      def copy_views
+        directory "pilgrim", "app/views/pilgrim"
+      end      
+    end
+  end
+end