geo_labels 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf986ec7c563cd8c2d4a80b0c47ba754995828ebdf137095504f0cd483cd31a
-  data.tar.gz: b67e43e78fcfc7990d6e0517de6fe13e2911ff018544b33d5af3c24d90099578
+  metadata.gz: 3d8a1e97c9ef4f47446cd94e6077b844c2a8bd7db58f28163330c0f6188592d1
+  data.tar.gz: a6378b02037f5f5b39fa10bdb6e761f487889a15b03f3c33bb40bc015bd19153
 SHA512:
-  metadata.gz: 44b8b346ca204d88afab5edeac9cd65e07490f49b8b394b873295df151182092573af0573ef290a2da67b31fa0be8d83cfcd78bb91da7adfe2fb1a70d4205250
-  data.tar.gz: cc33f0f8be30c3baf48092763cb11b26d6b6d6429a4c944512e3b9a1d1e393a220230b8801c47eb942d089327eac5a5f657856448f237474664a2734bc6a465f
+  metadata.gz: d78074f90bdace9bdb52da398d2f9a3bf057b6ef243e9eb4fdafc4397e2a62ad751bafeb605ba96a8900bdbfa7e20dbbbd953099793944550de3b5b8fa50b62c
+  data.tar.gz: 994ea71eecb76637ad3711b3afbf7e2c166ed6c189e2e89664f8f76a2578995574926e729adb3a0885d80e0e75eb05327e6bf4e441d506d0282011dfb6217d15

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 CHANGELOG of geo\_labels
 ============================
 
+2023-09-07 v0.3.2
+-------------------------
+* Add manual Google maps copy-paste string input option for complex locations
+
+2023-09-05 v0.3.1
+-------------------------
+* Better navigation connections
+* Fix the contact show map feature
+* Show label's connected contacts
+
+2023-09-04 v0.3.0
+-------------------------
+* Better README
+* Fuzzy search for all dropdowns
+* Change complex name to just name for contacts
+* Make main page contacts list first, map optional
+* Better label management GUI
+* Spanish translation for models
+* Comply with some rubocop suggestions
+
+2023-02-14 v0.2.1
+-------------------------
+* Default to ENV variable for google api key
+
 2023-02-10 v0.2.0
 -------------------------
 * Add importer link to menu

data/README.md

@@ -1,10 +1,21 @@
 # GeoLabels
-Short description and motivation.
+GeoLabels is a `rails` `engine` that allows you to create entries that will be resolved to
+their geographic location so that they can be shown on a map.
 
-## Usage
-How to use my plugin.
+The idea is to also create a hierarchical structure of labels and assign the lowest level applicable
+label to the contact entry.
+
+Now interesting queries can be made based on this organization. Examples:
+
+* Give me the good coffee places in the state of Texas
+* Give me the Vietnamese food places in Miami
+
+The geo-contacts and their labels can be managed in the engine's GUI, but also using a text format. This can be a useful,
+but also dangarous feature.
 
 ## Installation
+
+### Add the engine to your `rails` app
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -14,15 +25,125 @@ gem "geo_labels"
 And then execute:
 ```bash
 $ bundle
+$ bundle exec rails db:migrate
+```
+
+### Mount the engine to your routes
+In your `config/routes.rb` file add:
+```ruby
+  mount GeoLabels::Engine => '/geo-labels'
 ```
 
-Or install it yourself as:
+### Add the authorizations
+In your `app/models/ability.rb` file add the authorizations.
+This is a custom operation that you have to adjust to your needs.
+To allow all users full controll to the contracts add:
+```ruby
+    can :manage, GeoLabels::Contact
+    can :manage, GeoLabels::ContactLabel
+```
+
+If the `Ability` file does not yet exist, generate it using:
 ```bash
-$ gem install geo_labels
+rails generate cancan:ability
+```
+
+### Other languages (i18n)
+To use for a lets say Spanish based website add [rails-i18n](https://github.com/svenfuchs/rails-i18n) to your `Gemfile`
+
+```ruby
+gem 'rails-i18n'
 ```
 
+And configure your application in `config/application.rb` to handle the languages:
+
+```ruby
+  config.i18n.available_locales = %i[en es]
+  config.i18n.default_locale = :en
+```
+
+## Customization
+
+### The main page
+The main page of this engine is the query page where the created structure can be queried.
+
+### The link home content
+The default value for `config/application.rb` is:
+
+```ruby
+  config.x.geo_labels.link_home_content = -> { '<i class="arrow left icon"></i> Back' }
+```
+To change for example the icon, see the options at the [fomantic-ui](https://fomantic-ui.com/elements/icon.html) site.
+Note that the value is a `lambda` to allow the use of for example `I18n`.
+
 ## Contributing
-Contribution directions go here.
+There are many ways to contribute. Here some example steps that should work.
+
+### 1. Fork the repository
+Go to the original repository at https://gitlab.com/benja-2/geo\_labels and [fork](https://gitlab.com/benja-2/geo_labels/-/forks/new) the project.
+Then `git clone` your code on your local computer.
+
+If you are in the git repository directory you can tell your system to use the local code when actually the
+gitlab repository is specified for faster debugging. To achieve this type:
+
+```bash
+bundle config local.geo_labels .
+```
+
+### 2. Add your forked codebase to a project
+To start from zero, create a new rails (> 7) project and add the `geo_labels` gem configured to use `gitlab` as a base:
+
+```bash
+rails new my_geo_labels_project
+cd my_geo_labels_project
+```
+
+Then in the `Gemfile`
+```ruby
+git_source(:gitlab) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "git@gitlab.com:#{repo_name}.git"
+end
+
+gem 'geo_labels', gitlab: '<your gitlab name>/geo_labels', branch: :master
+```
+
+## TESTING
+### Testing against other databases
+Since there are some more advanced queries in this gem and was discovered that `mysql` does not support
+the `IN (SELECT ...)` syntax, support for testing against multiple databases was added.
+
+The default test (`rspec spec`) database is `sqlite`.
+
+#### Test against a mysql database
+To setup the mysql environment type (optional new window after the `docker-compose` command):
+```bash
+docker-compose test_mysql up
+DATABASE_URL=mysql2://root:password@127.0.0.1:33062/test rails db:create
+DATABASE_URL=mysql2://root:password@127.0.0.1:33062/test rails db:migrate
+```
+
+then run the specs against the mysql database:
+```bash
+DATABASE_URL=mysql2://root:password@127.0.0.1:33062/test rspec spec
+```
+
+#### Test against postgresql database
+To setup the postgresql environment type (optional new window after the `docker-compose` command):
+```bash
+docker-compose test_postgresql up
+DATABASE_URL=postgres://pguser:pgpassword@127.0.0.1:54321/test rails db:create
+DATABASE_URL=postgres://pguser:pgpassword@127.0.0.1:54321/test rails db:migrate
+```
+
+then run the specs against the mysql database:
+```bash
+DATABASE_URL=postgres://pguser:pgpassword@127.0.0.1:54321/test rspec spec
+```
+
+## CHANGELOG
+The CHANGELOG can be found using 
+[CHANGELOG.md](/CHANGELOG.md)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

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

@@ -1,6 +1,7 @@
 #= require jquery
 #= require jquery_ujs
 #= require semantic-ui
+#= require ./ratings
 
 window.initMap = ->
   if map_canvas = document.getElementById('map-canvas')
@@ -15,10 +16,20 @@ window.initMap = ->
         title: map_point.title
       false
 $ ->
-  $('.ui.dropdown').dropdown() # assume fomantic that has the clearable class option, a lot better than the below custom code
+  $('.ui.dropdown').dropdown
+    fullTextSearch: true
+
+  $('.tabular.menu .item').tab
+    onFirstLoad: (name) ->
+      initMap() if name is 'map'
+      true
+  $('.accordion').accordion()
+
+  $('[data-content],[data-html]').popup()
+
   $('.message .close').on 'click', ->
     $(@).closest('.message').transition('fade')
-  $('.accordion').accordion()
+
   $('.and-or-switch-buttons .button').on 'click', ->
     #debugger
     container = @parentNode

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

@@ -0,0 +1,80 @@
+# Supply a global initialization access point to load for custom actions
+window.divmod = (x, y) -> [Math.floor(x / y), x % y]
+window.setupRatings = ->
+  # For now jQuery based, but setup for easy future change to non jQuery systems
+  setClassForRatingDivmod = (star, whole_stars, half_star) ->
+    star_number = Number(star.dataset.starNumber)
+    if star_number + 1 > whole_stars + half_star
+      star.classList.add 'outline'
+    else
+      star.classList.remove 'outline'
+    star.classList.toggle 'half', star_number is whole_stars and half_star
+    #star.classList.toggle 'half', half_star
+    #
+  getStarEventRating = (star, event) ->
+    rect = event.target.getBoundingClientRect()
+    leftHalf = event.clientX < rect.x + rect.width / 2
+    hoverRating = event.target.dataset.starNumber * 2
+    hoverRating += if leftHalf then 1 else 2
+    hoverRating
+
+  mousemove = (event) ->
+    [whole_stars, half_star] = divmod(getStarEventRating(event.target, event), 2)
+    Array.from(event.target.parentElement.childNodes).forEach (star) ->
+      setClassForRatingDivmod star, whole_stars, half_star
+      star.classList.remove 'yellow'
+      star.classList.add 'orange'
+
+  mouseleave = (event) ->
+    rating = Number(event.target.parentElement.dataset.rating)
+    [whole_stars, half_star] = divmod(rating, 2)
+    Array.from(event.target.parentElement.childNodes).forEach (star) ->
+      setClassForRatingDivmod star, whole_stars, half_star
+      star.classList.remove 'orange'
+      star.classList.remove 'green'
+      star.classList.add 'yellow'
+
+  mouseclick = (event) ->
+    clickValue = getStarEventRating(event.target, event)
+    [whole_stars, half_star] = divmod(clickValue, 2)
+    Array.from(event.target.parentElement.childNodes).forEach (star) ->
+      star.classList.remove 'yellow'
+      star.classList.remove 'orange'
+    cdata = event.target.parentNode.dataset
+    post_data =
+      record:    cdata.record
+      record_id: cdata.recordId
+      topic:     cdata.topic
+      value:     clickValue
+    jQuery.post geo_labels.paths.set_rating, post_data, (response, status, jqXHR) ->
+      event.target.parentNode.dataset.rating = clickValue
+      Array.from(event.target.parentElement.childNodes).forEach (star) ->
+        star.classList.add 'green'
+        setTimeout ->
+          mouseleave(event)
+        , 1000
+    .fail (jqXHR) ->
+      # jqXHR.status is probably 422 or 403
+      alert "The rating cannot be updated"
+      mouseleave(event)
+
+
+  jQuery(document).ready ->
+    containers = document.getElementsByClassName 'rating-container'
+    for container in containers
+      container.innerHTML = ''
+      data = container.dataset
+      [whole_stars, half_star] = divmod(Number(data.rating), 2)
+      for star_index in [0...5]
+        icon = document.createElement 'i'
+        icon.className = 'yellow star icon'
+        #icon.classList.add 'half' if star_index is whole_stars and half_star
+        #if star_index > whole_stars
+        #  icon.classList.add 'outline'
+        icon.dataset.starNumber = star_index
+        setClassForRatingDivmod icon, whole_stars, half_star
+        icon.onmousemove  = (event) -> mousemove(event)
+        icon.onmouseleave = (event) -> mouseleave(event)
+        icon.addEventListener 'click', (event) -> mouseclick(event)
+        container.appendChild icon
+    false

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

@@ -6,5 +6,26 @@ main
     padding-top: 12px
   > .container .page-title
     padding-top: 12px
+  .page-title
+    .primary.button
+      float: right
+.rating-container i.icon.hidden
+  display: none
+
+.labels-tree
+  li
+    &:hover
+      background-color: #ddd
+      .icon
+        display: inline-block
+    .icon
+      float: right
+      margin-left: 10px
+      display: none
+    .table-link.edit
+      font-size: 0.5rem !important
+@media (hover: none)
+  .labels-tree li .icon
+    display: inline-block
 #map-canvas
   height: 600px

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GeoLabels
   module SharedTemplateAndInstanceMethods
     extend ActiveSupport::Concern
@@ -11,6 +13,7 @@ module GeoLabels
     def record_class
       result = controller_path.classify.safe_constantize
       raise "Cannot determine record_class from controller_path: #{controller_path}" unless result
+
       result
     end
 

data/app/controllers/geo_labels/application_controller.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 module GeoLabels
   class ApplicationController < ::ApplicationController
+
     helper_method :query
 
     def main
+      # root landing action
     end
 
     private

data/app/controllers/geo_labels/contacts_controller.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module GeoLabels
   class ContactsController < ApplicationController
+
     include SharedTemplateAndInstanceMethods
     respond_to :html
 
@@ -52,5 +54,21 @@ module GeoLabels
       @record.destroy
       redirect_to record_class, status: :see_other
     end
+
+    # PUT /contacts/:id/reject
+    def reject
+      # redirect_to record_class, alert: "Only contacts of state recomm"
+      @record = record_class.find params[:id]
+      @record.update state: 'rejected'
+      redirect_to @record, notice: 'Rejected'
+    end
+
+    # PUT /contacts/:id/reject
+    def approve
+      # redirect_to record_class, alert: "Only contacts of state recomm"
+      @record = record_class.find params[:id]
+      @record.update state: 'approved'
+      redirect_to @record, notice: 'Approved'
+    end
   end
 end

data/app/controllers/geo_labels/dashboard_controller.rb

@@ -1,26 +1,31 @@
+# frozen_string_literal: true
 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
+      return unless 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)
+      states_array = (params[:states].presence || 'approved').split(',')
+      @contacts = Contact.geocoded.for_label_ids(label_ids, predication: params[:predication], states: states_array)
     end
 
     def export
+      # SHOW action for the view to call the export_file action
     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
+                filename: "GeoLabels-export-#{timestamp}.yml",
+                type: :text,
+                disposition: :attachment
     end
 
     def import
+      # SHOW action for the view to call the import_file action
     end
 
     def import_file

data/app/controllers/geo_labels/labels_controller.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module GeoLabels
   class LabelsController < ApplicationController
+
     include SharedTemplateAndInstanceMethods
     respond_to :html
 
@@ -12,7 +14,7 @@ module GeoLabels
     end
 
     def new
-      @record = record_class.new
+      @record = record_class.new(parent_id: params[:parent_id])
       authorize! :create, @record
     end
 

data/app/controllers/geo_labels/ratings_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Separate ratings controller for easyer future extraction of functionality
+# posibly gem extraction if used sufficiently
+module GeoLabels
+  class RatingsController < ApplicationController
+
+    # Still has no application
+    def get
+      render plain: 'TODO app/controllers/geo_labels/ratings_controller.rb'
+    end
+
+    # PUT /geo-labels/ratings/set?record=GeoLabels::Contact&record_id=3&topic=food&value=7
+    def set
+      model = params[:record].safe_constantize
+      return render plain: '', status: :unprocessable_entity unless model&.include?(GeoLabels::RatingsSupport) # 422
+      return render plain: '', status: :unprocessable_entity unless model.rating_topics.include? params[:topic].to_sym
+
+      record = model.find(params[:record_id])
+      #TODO: add more sophisticated safeguard
+      record.rating[params[:topic]] = params[:value]
+
+      if record.save
+        render plain: ''
+      else
+        render plain: '', status: :unprocessable_entity
+      end
+    end
+  end
+end