spree_counties 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e93c413637e88d68cee31578248d340bb10ced70
+  data.tar.gz: b6f8a04f81f2afe561add3d03e051fe24b4bdc09
+SHA512:
+  metadata.gz: 035a10e4a361f0f965bc5ced571d3eff1f02cb67b0cc769109a83d09244a3e95234792980b864c955bd44cfa845b17dd2cede9ca08b05a89d9370c699c7a15af
+  data.tar.gz: ff6effea687e7e2bd76ddf6683e85539c4e095957b54fefc6147695dc4ca4cf512faf9a0424c50d6365d53dfa41eef166aff1130199dd810792527dc9d537b4c

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: 8

data/.gitignore

@@ -0,0 +1,14 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '2-3-stable'
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-3-stable'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gonzalo Moreno
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+Spree Counties
+=============
+
+Lets your users pick counties from states list in address's step
+
+![alt tag](https://raw.githubusercontent.com/ronzalo/spree_counties/master/lib/generators/spree_counties/install/templates/1.png)
+
+![alt tag](https://raw.githubusercontent.com/ronzalo/spree_counties/master/lib/generators/spree_counties/install/templates/2.png)
+
+Installation
+------------
+
+Add spree_counties to your Gemfile:
+
+```ruby
+gem 'spree_counties'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_counties:install
+```
+
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_counties/factories'
+```
+
+Copyright (c) 2014 Gonzalo Moreno C, released under the New BSD License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_counties'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/spree_counties.js

@@ -0,0 +1,30 @@
+var update_county = function (region, done) {
+  'use strict';
+
+  var state = $('span#' + region + 'state .select2').select2('val');
+  var county_select = $('span#' + region + 'county select.select2');
+
+  $.get('/api/counties?state_id=' + state, function (data) {
+    var counties = data.counties;
+    if (counties.length > 0) {
+      county_select.html('');
+      var counties_with_blank = [{
+        name: '',
+        id: ''
+      }].concat(counties);
+      $.each(counties_with_blank, function (pos, county) {
+        var opt = $(document.createElement('option'))
+          .prop('value', state.id)
+          .html(county.name);
+        county_select.append(opt);
+      });
+      county_select.prop('disabled', false).show();
+      county_select.select2();
+
+    } else {
+      county_select.select2('destroy').hide();
+    }
+
+    if(done) done();
+  });
+};

data/app/assets/javascripts/spree/frontend/spree_counties.js.coffee

@@ -0,0 +1,58 @@
+Spree.ready ($) ->
+  ($ '#bstate select').change ->
+    updateCounty 'b'
+
+  ($ '#sstate select').change ->
+    updateCounty 's'
+
+  updateCounty = (region) ->
+    stateId = getStateId(region)
+    if stateId?
+      $.get '/api/counties', {state_id: stateId}, (data) ->
+        Spree.Checkout[stateId] =
+          counties: data.counties
+        fillCounties(Spree.Checkout[stateId], region)
+
+  getStateId = (region) ->
+      $('#' + region + 'state select').val()
+
+  fillCounties = (data, region) ->
+    countiesRequired = true
+    counties = data.counties
+
+    countyPara = ($ '#' + region + 'county')
+    countySelect = countyPara.find('select')
+    countyInput = countyPara.find('input')
+    countySpanRequired = countyPara.find('county-required')
+    if counties.length > 0
+      selected = parseInt countySelect.val()
+      countySelect.html ''
+      countyWithBlank = [{ name: '', id: ''}].concat(counties)
+      $.each countyWithBlank, (idx, county) ->
+        opt = ($ document.createElement('option')).attr('value', county.id).html(county.name)
+        opt.prop 'selected', true if selected is county.id
+        countySelect.append opt
+
+      countySelect.prop('disabled', false).show()
+      countyInput.hide().prop 'disabled', true
+      countyPara.show()
+      countySpanRequired.show()
+      countySelect.addClass('required') if countiesRequired
+      countySelect.removeClass('hidden')
+      countyInput.removeClass('required')
+    else
+      countySelect.hide().prop 'disabled', true
+      countyInput.show()
+      if countiesRequired
+        countySpanRequired.show()
+        countyInput.addClass('required')
+      else
+        countyInput.val ''
+        countySpanRequired.hide()
+        countyInput.removeClass('required')
+      countyPara.toggle(!!countiesRequired)
+      countyInput.prop('disabled', !countiesRequired)
+      countyInput.removeClass('hidden')
+      countySelect.removeClass('required')
+
+  updateCounty 'b'

data/app/assets/stylesheets/spree/backend/spree_counties.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_counties.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/api/counties_controller.rb

@@ -0,0 +1,38 @@
+module Spree
+  module Api
+    class CountiesController < Spree::Api::BaseController
+      skip_before_filter :set_expiry
+      skip_before_filter :check_for_user_or_api_key
+      skip_before_filter :authenticate_user
+
+      def index
+        @counties = scope.ransack(params[:q]).result.
+                    includes(:state).order('name ASC')
+
+        if params[:page] || params[:per_page]
+          @counties = @counties.page(params[:page]).per(params[:per_page])
+        end
+
+        county = @counties.last
+        if stale?(county)
+          respond_with(@counties)
+        end
+      end
+
+      def show
+        @county = scope.find(params[:id])
+        respond_with(@county)
+      end
+
+      private
+        def scope
+          if params[:state_id]
+            @state = Spree::State.accessible_by(current_ability, :read).find(params[:state_id])
+            return @state.counties.accessible_by(current_ability, :read)
+          else
+            return Spree::County.accessible_by(current_ability, :read)
+          end
+        end
+    end
+  end
+end

data/app/models/county_ability.rb

@@ -0,0 +1,10 @@
+class CountyAbility
+  include CanCan::Ability
+
+  def initialize(user)
+    user ||= Spree::User.new
+    unless user.has_spree_role? 'admin'
+      can [:index, :read], Spree::County
+    end
+  end
+end

data/app/models/spree/address_decorator.rb

@@ -0,0 +1,7 @@
+module Spree
+  Address.class_eval do
+    belongs_to :county, class_name: "Spree::County"
+    Spree::PermittedAttributes.address_attributes << :county_id
+    Spree::PermittedAttributes.address_attributes << :county_name
+  end
+end

data/app/models/spree/county.rb

@@ -0,0 +1,13 @@
+class Spree::County < ActiveRecord::Base
+  belongs_to :state
+  has_many :addresses, dependent: :nullify
+  Spree::Ability.register_ability(CountyAbility)
+
+  def <=>(other)
+    name <=> other.name
+  end
+
+  def to_s
+    name
+  end
+end

data/app/models/spree/state_decorator.rb

@@ -0,0 +1,3 @@
+Spree::State.class_eval do
+  has_many :counties, -> { order('name ASC') }, dependent: :destroy
+end

data/app/views/spree/address/_form.html.erb

@@ -0,0 +1,86 @@
+<% address_id = address_type.chars.first %>
+<div class="inner" data-hook=<%="#{address_type}_inner" %>>
+  <p class="field" id=<%="#{address_id}firstname" %>>
+    <%= form.label :firstname, Spree.t(:first_name) %><span class="required">*</span><br />
+    <%= form.text_field :firstname, :class => 'required' %>
+  </p>
+  <p class="field" id=<%="#{address_id}lastname" %>>
+    <%= form.label :lastname, Spree.t(:last_name) %><span class="required">*</span><br />
+    <%= form.text_field :lastname, :class => 'required' %>
+  </p>
+  <% if Spree::Config[:company] %>
+    <p class="field" id=<%="#{address_id}company" %>>
+      <%= form.label :company, Spree.t(:company) %><br />
+      <%= form.text_field :company %>
+    </p>
+  <% end %>
+  <p class="field" id=<%="#{address_id}address1" %>>
+    <%= form.label :address1, Spree.t(:street_address) %><span class="required">*</span><br />
+    <%= form.text_field :address1, :class => 'required' %>
+  </p>
+  <p class="field" id=<%="#{address_id}address2" %>>
+    <%= form.label :address2, Spree.t(:street_address_2) %><br />
+    <%= form.text_field :address2 %>
+  </p>
+  <p class="field" id=<%="#{address_id}city" %>>
+    <%= form.label :city, Spree.t(:city) %><span class="required">*</span><br />
+    <%= form.text_field :city, :class => 'required' %>
+  </p>
+  <p class="field" id=<%="#{address_id}country" %>>
+    <%= form.label :country_id, Spree.t(:country) %><span class="required">*</span><br />
+    <span id=<%="#{address_id}country-selection" %>>
+      <%= form.collection_select :country_id, available_countries, :id, :name, {}, {:class => 'required'} %>
+    </span>
+  </p>
+
+  <% if Spree::Config[:address_requires_state] %>
+    <p class="field" id=<%="#{address_id}state" %>>
+      <% have_states = !address.country.states.empty? %>
+      <%= form.label :state, Spree.t(:state) %><span class='required' id=<%="#{address_id}state-required"%>>*</span><br/>
+
+      <% state_elements = [
+         form.collection_select(:state_id, address.country.states,
+                            :id, :name,
+                            {:include_blank => true},
+                            {:class => have_states ? 'required' : 'hidden',
+                            :disabled => !have_states}) +
+         form.text_field(:state_name,
+                            :class => !have_states ? 'required' : 'hidden',
+                            :disabled => have_states)
+         ].join.gsub('"', "'").gsub("\n", "")
+      %>
+      <%= javascript_tag do -%>
+        $('#<%="#{address_id}state" %>').append("<%== state_elements %>");
+      <% end %>
+    </p>
+      <noscript>
+        <%= form.text_field :state_name, :class => 'required' %>
+      </noscript>
+
+    <p class="field" id=<%="#{address_id}county" %>>
+      <%= form.label :county do %>
+        <%= Spree.t(:county) %>
+        <span class="required" id=<%="#{address_id}county-required"%>>*</span>
+      <% end %>
+      <%= form.collection_select(:county_id, [],
+                              :id, :name,
+                              {:include_blank => true},
+                              {:class => "form-control required",}) %>
+    </p>
+  <% end %>
+
+  <p class="field" id=<%="#{address_id}zipcode" %>>
+    <%= form.label :zipcode, Spree.t(:zip) %><% if address.require_zipcode? %><span class="required">*</span><br /><% end %>
+    <%= form.text_field :zipcode, :class => "#{'required' if address.require_zipcode?}" %>
+  </p>
+  <p class="field" id=<%="#{address_id}phone" %>>
+    <%= form.label :phone, Spree.t(:phone) %><% if address.require_phone? %><span class="required">*</span><br /><% end %>
+    <%= form.phone_field :phone, :class => "#{'required' if address.require_phone?}" %>
+  </p>
+  <% if Spree::Config[:alternative_shipping_phone] %>
+    <p class="field" id=<%="#{address_id}altphone" %>>
+      <%= form.label :alternative_phone, Spree.t(:alternative_phone) %><br />
+      <%= form.phone_field :alternative_phone %>
+    </p>
+  <% end %>
+</div>

data/app/views/spree/admin/shared/_address_form.html.erb

@@ -0,0 +1,81 @@
+<% s_or_b = type.chars.first %>
+
+<div id="<%= type %>" data-hook="address_fields">
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :firstname, Spree.t(:first_name) %>
+    <%= f.text_field :firstname, :class => 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :lastname, Spree.t(:last_name) %>
+    <%= f.text_field :lastname, :class => 'fullwidth' %>
+  </div>
+
+  <% if Spree::Config[:company] %>
+    <div class="field <%= "#{type}-row" %>">
+      <%= f.label :company, Spree.t(:company) %>
+      <%= f.text_field :company, :class => 'fullwidth' %>
+    </div>
+  <% end %>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :address1, Spree.t(:street_address) %>
+    <%= f.text_field :address1, :class => 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :address2, Spree.t(:street_address_2) %>
+    <%= f.text_field :address2, :class => 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :city, Spree.t(:city) %>
+    <%= f.text_field :city, :class => 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :zipcode, Spree.t(:zip) %>
+    <%= f.text_field :zipcode, :class => 'fullwidth' %>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :country_id, Spree.t(:country) %>
+    <span id="<%= s_or_b %>country">
+      <%= f.collection_select :country_id, available_countries, :id, :name, {}, {:class => 'select2 fullwidth'} %>
+    </span>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :state_id, Spree.t(:state) %>
+    <span id="<%= s_or_b %>state">
+      <%= f.text_field :state_name,
+            :style => "display: #{f.object.country.states.empty? ? 'block' : 'none' };",
+           :disabled => !f.object.country.states.empty?, :class => 'fullwidth state_name' %>
+      <%= f.collection_select :state_id, f.object.country.states.sort, :id, :name, {:include_blank => true}, {:class => 'select2 fullwidth', :style => "display: #{f.object.country.states.empty? ? 'none' : 'block' };", :disabled => f.object.country.states.empty?} %>
+    </span>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :county_id, Spree.t(:county) %>
+    <span id="<%= s_or_b %>county">
+      <%= f.text_field :county_name,
+            :style => "display: #{f.object.state.counties.empty? ? 'block' : 'none' };",
+           :disabled => !f.object.state.counties.empty?, :class => 'fullwidth county_name' %>
+      <%= f.collection_select :county_id, f.object.state.counties.sort, :id, :name, {:include_blank => true}, {:class => 'select2 fullwidth', :style => "display: #{f.object.state.counties.empty? ? 'none' : 'block' };", :disabled => f.object.state.counties.empty?} %>
+    </span>
+  </div>
+
+  <div class="field <%= "#{type}-row" %>">
+    <%= f.label :phone, Spree.t(:phone) %>
+    <%= f.phone_field :phone, :class => 'fullwidth' %>
+  </div>
+</div>
+
+<% content_for :head do %>
+  <%= javascript_tag do -%>
+    $(document).ready(function(){
+      $('span#<%= s_or_b %>country .select2').on('change', function() { update_state('<%= s_or_b %>'); });
+      $('span#<%= s_or_b %>state .select2').on('change', function() { update_county('<%= s_or_b %>'); });
+    });
+  <% end -%>
+<% end %>

data/app/views/spree/api/counties/index.v1.rabl

@@ -0,0 +1,11 @@
+object false
+
+child(@counties => :counties) do
+  attributes :id, :name
+end
+
+if @counties.respond_to?(:num_pages)
+  node(:count) { @counties.count }
+  node(:current_page) { params[:page] || 1 }
+  node(:pages) { @counties.num_pages }
+end

data/app/views/spree/api/counties/show.v1.rabl

@@ -0,0 +1,2 @@
+object @county
+attributes :id, :name

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_counties/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+  namespace :api, :defaults => { :format => 'json' } do
+    resources :counties, :only => [:index, :show]
+  end
+end

data/db/migrate/20140729200830_create_spree_counties.rb

@@ -0,0 +1,10 @@
+class CreateSpreeCounties < ActiveRecord::Migration
+  def change
+    create_table :spree_counties do |t|
+      t.string :name
+      t.references :state, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140729203900_add_spree_county_reference_to_spree_address.rb

@@ -0,0 +1,5 @@
+class AddSpreeCountyReferenceToSpreeAddress < ActiveRecord::Migration
+  def change
+    add_reference :spree_addresses, :county, index: true
+  end
+end

data/db/migrate/20141119225426_add_county_name_to_spree_address.rb

@@ -0,0 +1,5 @@
+class AddCountyNameToSpreeAddress < ActiveRecord::Migration
+  def change
+    add_column :spree_addresses, :county_name, :string
+  end
+end

data/lib/generators/spree_counties/install/install_generator.rb

@@ -0,0 +1,41 @@
+module SpreeCounties
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_counties\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_counties\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/spree_counties\n", :before => /\*\//, :verbose => true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/spree_counties\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_counties'
+      end
+
+      def run_seeds
+        run_seeds = options[:auto_run_seeds] || ['', 'y', 'Y'].include?(ask 'Would you like to load chilean example seeds now? [Y/n]')
+        if run_seeds
+          copy_file "seeds/counties.rb", "db/seeds/counties.rb"
+          run 'bundle exec rails runner db/seeds/counties.rb'
+        else
+          puts 'Skipping bundle exec rails runner, don\'t forget to run it!'
+        end
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end