geo_labels 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bf986ec7c563cd8c2d4a80b0c47ba754995828ebdf137095504f0cd483cd31a
+  data.tar.gz: b67e43e78fcfc7990d6e0517de6fe13e2911ff018544b33d5af3c24d90099578
+SHA512:
+  metadata.gz: 44b8b346ca204d88afab5edeac9cd65e07490f49b8b394b873295df151182092573af0573ef290a2da67b31fa0be8d83cfcd78bb91da7adfe2fb1a70d4205250
+  data.tar.gz: cc33f0f8be30c3baf48092763cb11b26d6b6d6429a4c944512e3b9a1d1e393a220230b8801c47eb942d089327eac5a5f657856448f237474664a2734bc6a465f

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+CHANGELOG of geo\_labels
+============================
+
+2023-02-10 v0.2.0
+-------------------------
+* Add importer link to menu
+* Add importer view
+* Add import file action
+* Add importer spec
+* Add exporter spec
+* Better labels tree on it\'s index page
+
+2022-10-19 Initial setup
+-------------------------
+The base code

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Benjamin ter Kuile
+
+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,28 @@
+# GeoLabels
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "geo_labels"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install geo_labels
+```
+
+## 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/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/geo_labels_manifest.js

@@ -0,0 +1,2 @@
+//= link geo_labels/application.css
+//= link geo_labels/application.js

data/app/assets/javascripts/geo_labels/application.coffee

@@ -0,0 +1,29 @@
+#= require jquery
+#= require jquery_ujs
+#= require semantic-ui
+
+window.initMap = ->
+  if map_canvas = document.getElementById('map-canvas')
+    window.google_map = new google.maps.Map map_canvas,
+      center: map_points[0]
+      zoom: 9
+
+    map_points.forEach (map_point) ->
+      marker = new google.maps.Marker
+        position: map_point
+        map: google_map
+        title: map_point.title
+      false
+$ ->
+  $('.ui.dropdown').dropdown() # assume fomantic that has the clearable class option, a lot better than the below custom code
+  $('.message .close').on 'click', ->
+    $(@).closest('.message').transition('fade')
+  $('.accordion').accordion()
+  $('.and-or-switch-buttons .button').on 'click', ->
+    #debugger
+    container = @parentNode
+    button.classList.remove('secondary') for button in container.getElementsByClassName('button')
+    @classList.add('secondary')
+    container.querySelector('input').value = @dataset.predicate
+    #$(@).find('button').removeClass ''
+    false

data/app/assets/stylesheets/geo_labels/application.sass

@@ -0,0 +1,10 @@
+@import "semantic-ui"
+main
+  min-height: calc(100% - 57px - 1rem) // 34px for footer inclusion
+  padding-top: 40px
+  > .page-title
+    padding-top: 12px
+  > .container .page-title
+    padding-top: 12px
+#map-canvas
+  height: 600px

data/app/controllers/concerns/geo_labels/shared_template_and_instance_methods.rb

@@ -0,0 +1,21 @@
+module GeoLabels
+  module SharedTemplateAndInstanceMethods
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :record_class
+    end
+
+    private
+
+    def record_class
+      result = controller_path.classify.safe_constantize
+      raise "Cannot determine record_class from controller_path: #{controller_path}" unless result
+      result
+    end
+
+    def record_params
+      params.require(record_class.name.demodulize.underscore).permit!
+    end
+  end
+end

data/app/controllers/geo_labels/application_controller.rb

@@ -0,0 +1,14 @@
+module GeoLabels
+  class ApplicationController < ::ApplicationController
+    helper_method :query
+
+    def main
+    end
+
+    private
+
+    def query
+      params[:q]
+    end
+  end
+end

data/app/controllers/geo_labels/contacts_controller.rb

@@ -0,0 +1,56 @@
+module GeoLabels
+  class ContactsController < ApplicationController
+    include SharedTemplateAndInstanceMethods
+    respond_to :html
+
+    def index
+      authorize! :index, record_class
+      @q = record_class.ransack query
+      @q.sorts = 'name asc' if @q.sorts.empty?
+      @records = @q.result.page(params[:page]).per(100)
+      respond_with(@records)
+    end
+
+    def new
+      @record = record_class.new
+      authorize! :create, @record
+    end
+
+    def create
+      @record = record_class.new record_params
+      authorize! :create, @record
+      if @record.save
+        redirect_to @record, status: :see_other
+      else
+        render action: 'new'
+      end
+    end
+
+    def show
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+    end
+
+    def edit
+      @record = record_class.find(params[:id])
+      authorize! :edit, @record
+    end
+
+    def update
+      @record = record_class.find params[:id]
+      authorize! :edit, @record
+      if @record.update record_params
+        redirect_to @record, status: :see_other
+      else
+        render action: 'edit'
+      end
+    end
+
+    def destroy
+      @record = record_class.find params[:id]
+      authorize! :destroy, @record
+      @record.destroy
+      redirect_to record_class, status: :see_other
+    end
+  end
+end

data/app/controllers/geo_labels/dashboard_controller.rb

@@ -0,0 +1,33 @@
+module GeoLabels
+  class DashboardController < ApplicationController
+    def main
+      if params[:label_ids].present?
+        label_ids = params[:label_ids]
+        # fomantic-ui uses comma separated id values
+        label_ids = label_ids.to_s.split(',') unless label_ids.is_a?(Array)
+        @contacts = Contact.geocoded.for_label_ids(label_ids, predication: params[:predication])
+      end
+    end
+
+    def export
+    end
+
+    def export_file
+      timestamp = Time.now.utc.iso8601.first(19).gsub(/-|:/, '')
+      send_data GeoLabels::Exporter.export_str,
+        filename: "GeoLabels-export-#{timestamp}.yml",
+        type: :text,
+        disposition: :attachment
+    end
+
+    def import
+    end
+
+    def import_file
+      Importer.import params[:file]
+      redirect_to root_path, notice: 'File imported'
+    rescue => e
+      redirect_to import_path, alert: e.message
+    end
+  end
+end

data/app/controllers/geo_labels/labels_controller.rb

@@ -0,0 +1,56 @@
+module GeoLabels
+  class LabelsController < ApplicationController
+    include SharedTemplateAndInstanceMethods
+    respond_to :html
+
+    def index
+      authorize! :index, record_class
+      @q = record_class.ransack query
+      @q.sorts = 'name asc' if @q.sorts.empty?
+      @records = @q.result.page(params[:page]).per(100)
+      respond_with(@records)
+    end
+
+    def new
+      @record = record_class.new
+      authorize! :create, @record
+    end
+
+    def create
+      @record = record_class.new record_params
+      authorize! :create, @record
+      if @record.save
+        redirect_to @record, status: :see_other
+      else
+        render action: 'new'
+      end
+    end
+
+    def show
+      @record = record_class.find params[:id]
+      authorize! :show, @record
+    end
+
+    def edit
+      @record = record_class.find(params[:id])
+      authorize! :edit, @record
+    end
+
+    def update
+      @record = record_class.find params[:id]
+      authorize! :edit, @record
+      if @record.update record_params
+        redirect_to @record, status: :see_other
+      else
+        render action: 'edit'
+      end
+    end
+
+    def destroy
+      @record = record_class.find params[:id]
+      authorize! :destroy, @record
+      @record.destroy
+      redirect_to record_class, status: :see_other
+    end
+  end
+end

data/app/helpers/geo_labels/application_helper.rb

@@ -0,0 +1,197 @@
+module GeoLabels
+  module ApplicationHelper
+    def link_to_labels_tree
+      #output = "<ul class='ui list'>"
+      output = tag.ul(class: 'ui list')[0..-6]
+      add_punctuation = '*'
+      tree_formatter = Proc.new do |items, lead_space|
+        items.each do |item|
+          output += "#{lead_space}#{tag.li link_to(item[:name], label_path(item[:id]))}\n".html_safe
+          if item[:children].present?
+            output += "#{lead_space}<ul>".html_safe
+            tree_formatter.call(item[:children], lead_space + '  ')
+            output += "#{lead_space}</ul>".html_safe
+          end
+        end
+      end
+      tree_formatter.call(GeoLabels::Exporter.labels_tree_h, '')
+      #output.gsub!(/^(\s*)  /, "\1#{add_punctuation} ") if add_punctuation.present?
+      output += '</ul>'.html_safe
+      output.html_safe
+    end
+    # Return active or nil based on the given route spec
+    #   %li{ class: active_class('users') # true if controller is users, false otherwise
+    #   %li{ class: active_class('pages#about') # true if controller is pages and action is about
+    #NOTE: Taken from the dunlop-core gem. That is the best maintained version
+    def active_class(*route_specs)
+      options = route_specs.extract_options!
+      return nil if Array.wrap(options[:except]).any?{|exception| current_route_spec?(exception) }
+      return 'active' if route_specs.any?{|rs| current_route_spec?(rs, options) }
+      nil
+    end
+
+    # Check if the current route matches the route given as argument.
+    # The syntax is meant to be a bit similar to specifying routes in
+    # `config/routes.rb`.
+    #   current_route_spec?('products') #=> true if controller name is products, false otherwise
+    #   current_route_spec?('products#show') #=> true if controller_name is products AND action_name is show
+    #   current_route_spec?('#show') #=> true if action_name is show, false otherwise
+    #NOTE: this helper is tested through the active_class helper
+    #NOTE: Taken from the dunlop-core gem. That is the best maintained version
+    def current_route_spec?(route_spec, options = {})
+      return route_spec.match([controller_path, action_name].join('#')) if route_spec.is_a?(Regexp)
+      controller, action = route_spec.split('#')
+      return action == params[:id] if controller_path == 'high_voltage/pages'
+      actual_controller_parts = controller_path.split('/')
+      if controller #and controller_path == controller
+        tested_controller_parts = controller.split('/')
+        return if tested_controller_parts.size > actual_controller_parts.size
+        if actual_controller_parts[0...tested_controller_parts.size] == tested_controller_parts
+          # controller spec matches
+          return true unless action
+          action_name == action
+        end
+      else
+        action_name == action
+      end
+    end
+
+    #NOTE: Taken from the dunlop-core gem. That is the best maintained version
+    def page_title(*args, &blk)
+      extra_content = capture(&blk) if blk.present?
+      if resource_title?(args)
+        @scope_model = args[1].is_a?(ActiveRecord::Base) ? args[1].class : args[1]
+        content = page_title_for_resource(args)
+      else
+        content = page_title_for_string(args)
+      end
+      content += extra_content if extra_content.present?
+      title_tag = content_tag(:h2, content, class: 'page-title ui header')
+      content_for :page_title, title_tag
+      title_tag
+    end
+
+    def resource_title?(args)
+      args.first.is_a?(Symbol) &&
+        (args[1].respond_to?(:model_name) || args[1].class.respond_to?(:model_name))
+    end
+
+    def page_title_for_string(args)
+      title = html_escape(args.first)
+      options = args.last.is_a?(Hash) ? args.last : {}
+      if back_options = options[:back]
+        url =
+          case back_options
+          when Array then polymorphic_path(back_options)
+          when true then :back
+          else back_options
+          end
+        if url
+          back_link = link_to content_tag(:i, nil, class: 'left arrow icon'), url, class: 'title-back-link'
+          title = back_link.safe_concat(title)
+        end
+      end
+      title
+    end
+
+    def page_title_for_resource(args)
+      options = args.extract_options!
+      model = args[1].respond_to?(:model_name) ? args[1] : args[1].class
+      if args.first == :index
+        title = t('action.index.label', models: model.model_name.human_plural).html_safe
+      else
+        title = t("action.#{args.first}.label", model: model.model_name.human).html_safe
+      end
+      if back_options = options[:back]
+        url =
+          case back_options
+          when Array then polymorphic_path(back_options)
+          when true then :back
+          else back_options
+          end
+        if url
+          back_link = link_to content_tag(:i, nil, class: 'left arrow icon'), url, class: 'title-back-link'
+          title = back_link.safe_concat(title)
+        end
+      end
+      title
+    end
+
+    def search_result_info(records)
+      from_item = (records.current_page - 1) * records.limit_value + 1
+      to_item = [from_item + records.size - 1, records.total_count].min
+      from_item = 0 if records.total_count.zero?
+      "#{from_item} - #{to_item} / #{records.total_count}"
+    end
+
+    def at(attribute_name, scope_model=nil)
+      scope_model ||= @scope_model
+      scope_model.human_attribute_name(attribute_name)
+    end
+
+    # Search helpers from dunlop
+    def search_row(options = {}, &blk)
+      classes = Array.wrap(options[:class])
+      classes |= ['search']
+      classes << 'conditions-present' if @q.conditions.present?
+      content = capture(&blk)
+      content_tag(:tr, content,  class: classes )
+    end
+
+    # This helper returns the link for showing a record inside a table
+    def table_show_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :show, record
+      end
+      link_to(content_tag(:i,nil, class: 'folder open icon'), path || record, class: 'table-link show ui mini basic primary icon button')
+    end
+
+    # This helper returns the link for showing a record inside a table
+    def table_download_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :download, record
+      end
+      link_to(content_tag(:i,nil, class: 'download icon'), path || [:download, record], class: 'table-link download ui mini violet icon button')
+    end
+
+    # This helper returns the link for editing a record inside a table
+    def table_edit_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :update, record
+      end
+      link_to(content_tag(:i, nil, class: 'write icon'), path || [:edit, record], class: 'table-link edit ui mini basic yellow icon button')
+    end
+
+    def table_destroy_link(record, path = nil, options = {})
+      if options.has_key?(:authorized)
+        return unless options[:authorized]
+      else
+        return unless can? :destroy, record
+      end
+      confirm_text = "Are you sure you want to delete #{record.class.model_name.human}"
+      record_name = nil
+      record_name = record.presentation_name if record.respond_to?(:presentation_name)
+      record_name ||= record.name if record.respond_to?(:name)
+      record_name ||= record.title if record.respond_to?(:title)
+      confirm_text << " #{record_name}" if record_name.present?
+      confirm_text << "?"
+      link_to(content_tag(:i, nil, class: 'trash icon'), path || record, method: :delete, data: { confirm: confirm_text }, class: 'table-link destroy ui mini negative icon button')
+    end
+
+    # https://coderwall.com/p/7gqmog/display-flash-messages-with-semantic-ui-in-rails
+    def flash_class(level)
+      case level.to_sym
+      when :success       then "ui positive message"
+      when :error, :alert then "ui negative message"
+      when :notice        then "ui info message"
+      else "ui #{level} message"
+      end
+    end
+  end
+end

data/app/jobs/geo_labels/application_job.rb

@@ -0,0 +1,4 @@
+module GeoLabels
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/geo_labels/application_mailer.rb

@@ -0,0 +1,6 @@
+module GeoLabels
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/geo_labels/application_record.rb

@@ -0,0 +1,5 @@
+module GeoLabels
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/geo_labels/contact.rb

@@ -0,0 +1,64 @@
+module GeoLabels
+  class Contact < ApplicationRecord
+    extend Geocoder::Model::ActiveRecord
+    has_many :contact_labels, dependent: :delete_all
+    has_many :labels, through: :contact_labels
+
+    geocoded_by :address
+
+    after_validation :geocode_if_necessary
+
+    def self.for_label_ids(label_ids, predication: 'and')
+      #predication = %w[and or].include?(predication) ? predication : 'and' #whitlelisting
+      if predication == 'or'
+        joins(:labels).merge(Label.descendants_for_ids(label_ids)).distinct
+      else
+        where id: ContactLabel.contact_ids_for_label_ids(label_ids)
+      end
+    end
+
+    def label_ids=(array_or_string)
+      super array_or_string.is_a?(Array) ? array_or_string : array_or_string.split(',')
+    end
+
+    def address
+      [street, city, state, country].map(&:presence).compact.join(', ')
+    end
+
+    def address_changed?
+      street_changed? or city_changed? or state_changed? or country_changed?
+    end
+
+    def full_name
+      [first_name, middle_name, last_name].map(&:presence).compact.join(' ')
+    end
+
+    ransacker :full_name do |parent|
+      Arel::Nodes::InfixOperation.new('||', Arel::Nodes::InfixOperation.new('||', parent.table[:first_name], parent.table[:middle_name]), parent.table[:last_name])
+    end
+
+    def map_title
+      full_name
+    end
+
+    def map_attributes
+      return {} unless geocoded?
+      {
+        lat: latitude,
+        lng: longitude,
+        title: map_title
+      }
+    end
+
+    def geocode_if_necessary
+      return if new_record? and latitude.present? and longitude.present?
+      if address_changed?
+        self.latitude = nil
+        self.longitude = nil
+        # Geocode addresses with at least 2 commas
+        geocode if address.count(',') > 1
+      end
+    end
+
+  end
+end

data/app/models/geo_labels/contact_label.rb

@@ -0,0 +1,40 @@
+module GeoLabels
+  class ContactLabel < ApplicationRecord
+    belongs_to :contact
+    belongs_to :label
+
+    ### The strategy
+    # Join all possible collection label matches
+    # Then expec the amount of found matches to be the amount of requested labels (match all label groups).
+    # Sadly this stragegy fails when a contact has to labels assigned (Indonesian AND Vietnamese food), and
+    # the query is for all food categories (parent).
+    # Works for simple and concice situations. Not for multi label definitions
+    def self.contact_ids_for_label_ids2(label_ids)
+      label_ids = label_ids.to_s.split(',') unless label_ids.is_a?(Array)
+      scope = joins(:label).merge(Label.descendants_for_ids(label_ids)).select(:contact_id).group(:contact_id)
+      scope = scope.having(arel_table[:contact_id].count.eq label_ids.size).reorder('')
+      scope
+    end
+
+    ### The strategy:
+    # Create a subquery for each label collection possible situation
+    # Then join all these subqueries on the contact_id to remain only
+    # with the records having the contact_id in each of these subqueries
+    def self.contact_ids_for_label_ids(label_ids)
+      label_ids = label_ids.to_s.split(',') unless label_ids.is_a?(Array)
+
+      records = Label.find(label_ids)
+
+      scope = joins(%|INNER JOIN "geo_labels_labels" ON "geo_labels_labels"."id" = "geo_labels_contact_labels"."label_id"|).merge(records.shift.self_and_descendants).reorder('').select(:contact_id)
+      records.each do |record|
+        record_scope = joins(:label).merge(record.self_and_descendants).reorder('').select(:contact_id)
+        join_table_name = "labeltable#{record.id}"
+        join_table_contact_id = Arel::Nodes::SqlLiteral.new("#{join_table_name}.contact_id")
+        query_str = %|INNER JOIN (#{record_scope.to_sql}) #{join_table_name} ON #{arel_table[:contact_id].eq(join_table_contact_id).to_sql}|
+        scope = scope.joins(query_str)
+        #descendants_scope = descendants_scope.or(record.self_and_descendants)
+      end
+      scope
+    end
+  end
+end

data/app/models/geo_labels/label.rb

@@ -0,0 +1,15 @@
+module GeoLabels
+  class Label < ApplicationRecord
+    has_many :contact_labels, dependent: :delete_all
+    acts_as_nested_set
+
+    def self.descendants_for_ids(ids)
+      records = find(ids)
+      descendants_scope = records.shift.self_and_descendants
+      records.each do |record|
+        descendants_scope = descendants_scope.or(record.self_and_descendants)
+      end
+      descendants_scope
+    end
+  end
+end

data/app/views/geo_labels/application/_button-destroy-record.html.slim

@@ -0,0 +1 @@
+= link_to t('action.destroy.label', model: (record_class).model_name.human), record, class: 'ui red button', method: :delete, data: { confirm: t('general.are_you_sure') }

data/app/views/geo_labels/application/_button-edit-record.html.slim

@@ -0,0 +1 @@
+= link_to t('action.edit.label', model: (record_class).model_name.human), polymorphic_path(record, action: :edit), class: 'ui yellow button'

data/app/views/geo_labels/application/_button-new-record.html.slim

@@ -0,0 +1 @@
+= link_to t('action.new.label', model: (record_class).model_name.human), polymorphic_path(record_class, action: :new), class: 'ui primary basic button'

data/app/views/geo_labels/application/_messages.html.slim

@@ -0,0 +1,4 @@
+- flash.each do |key, value|
+  .closable.visible class=flash_class(key)
+    i.close.icon
+    = value