help-anywhere 0.1.3 → 0.1.4b

data/README.rdoc

@@ -36,11 +36,62 @@ See help-anywhere-example project for more information!
 
 Log-in has edit mode, and create new help page with our editor. Enjoy!
 
+== Require authorization for edit mode.
+
+If you just follow the steps before, there is no authorization needed to edit the pages and components of your help.
+But you can add it easily:
+
+in `yourapp/config/initializers/help_anywhere.rb` just set:
+
+  HelpAnywhere.configure do |config|
+    # Set here the method which is called to allow or disallow edition mode
+    # You can create this method in your ApplicationController class.
+    # By default, this will always return always true: every one can edit help.
+    config.edition_role = :can_user_edit_help?
+  end
+
+
+== Routing the content
+
+You can route dynamically for your help resource. A route will match an url with a specific help resource name.
+
+Example:
+
+
+  config.routes do |routes|
+    routes.match '/articles/*/show...', 'articles#show'
+  end
+
+
+This will allow every resource located at http://mywebsite/articles/xxxx/show(/xxx/yyy/zzz...) to share the same help (here articles#show page).
+
+You can use `*` to wilcard a path level, and `...` to wilcard everything after. Samely, you can use `?` and  `??` to use it in output:
+
+Example:
+
+    config.routes do |routes|
+      routes.match '/?/*/?', '$1#$2' # ex: url /resource/1/edit <=> resource#edit help page
+    end
+
+
+By default, every url create a new help resource. Keep in mind the hash part of the url is not used. For plugins for ajax which use hash part (like jquery-bbq), you need to refine manually the route like this:
+
+
+    $(window).bind( 'hashchange', function(e) {
+      //Force help-anywhere to get resource manually
+      HelpAnywhere.retrieveResource(HelpAnywhere.selectRoute($.param.fragment()));
+    });
+
 == Version
 
+0.1.4
+
+- Now you can bind a bubble to an element without typing the selector manually. A button provide an interface to select an object into the page.
+  You can select anything, but take care about dynamic content (over routes), otherwise your block can be missplaced! 
+
 0.1.1
 
 - This is the first stable release!
 - HelpAnywhere is provided with Bubble component, but you can also build your own. Check `app/javascript/bubble.coffee.js`
   for more informations.
-  You can ignore this component. Just `require help_anywhere_core_only` in  both application.js and .css
+  You can ignore this component. Just `require help_anywhere_core_only` in  both application.js and .css

data/Rakefile

@@ -34,5 +34,8 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task :default => :test
+
+task :server, [:args] do |t, args|
+  exec "cd test/dummy && rails s #{args[:args]}"
+end

data/app/assets/javascripts/help_anywhere/components/bubble.js.coffee

@@ -8,6 +8,90 @@
   Here we code all logic for show and edit mode.
 ###
 do ( $ = jQuery ) ->
+
+  ###
+    HTML SELECTION SYSTEM
+  ###
+  getAbsoluteSelectorFor = (elm) ->
+    return '' if elm.get(0).tagName is 'BODY'
+
+    if (id = elm.attr('id'))?
+      return "##{id}"
+
+    selector = elm.parents().toArray()
+    .map (x) ->
+      out = x.tagName
+      if (id = $(x).attr('id'))?
+        out += "##{id}"
+      if (classes = $(x).attr('class'))? and classes isnt ''
+        out += classes.split(/\s/g).map((x)-> '.' + x).join()
+      return out
+    .reverse()
+    .join('>')
+
+    selector  +=  ">:nth-child(#{elm.index()+1})"
+
+    return selector
+
+  window.HookingSystem =
+    currentMouseMoveTarget: null
+    enabled: false
+
+    callback: (selector) ->
+
+    enable: (callback) ->
+      $("#help-anywhere-layout").css display: 'none'
+
+      @callback      = callback
+      @enabled       = true
+      @stopMouseMove = false
+
+
+  handleMouseDown = (evt) ->
+    return true unless HookingSystem.enabled
+
+    HookingSystem.antiClickLayer ?= $('<div>').css(
+      position: 'fixed'
+      width: '100%'
+      height: '100%'
+      'background-color': 'transparent'
+      'z-index': '20001'
+      top: '0'
+      left: '0'
+    )
+
+    HookingSystem.antiClickLayer.appendTo($('body'))
+    HookingSystem.antiClickLayer.on 'mouseup', handleMouseClick
+    HookingSystem.stopMouseMove =  true
+
+  handleMouseClick = (evt) ->
+    evt.preventDefault()
+    evt.stopPropagation()
+
+    $(HookingSystem.currentMouseMoveTarget).removeClass("ha-hook-hover")
+
+    HookingSystem.callback(getAbsoluteSelectorFor($(HookingSystem.currentMouseMoveTarget)))
+    HookingSystem.enabled = false
+
+    HookingSystem.antiClickLayer.remove()
+
+    HookingSystem.antiClickLayer = null
+    HookingSystem.currentMouseMoveTarget = null
+
+    $("#help-anywhere-layout").css display: 'block'
+
+  handleMouseMove = (evt) ->
+    return true unless HookingSystem.enabled and not HookingSystem.stopMouseMove
+
+    $(HookingSystem.currentMouseMoveTarget).removeClass('ha-hook-hover')
+
+    $(evt.target).addClass('ha-hook-hover')
+
+    HookingSystem.currentMouseMoveTarget = evt.target
+
+  $("html").on 'mousemove', handleMouseMove
+  $("html").on 'mousedown', handleMouseDown
+
   BUBBLE_TEMPLATE = -> """
     <div class="ha-bubble-box">
       <div class="ha-bubble-pointer"></div>
@@ -31,7 +115,7 @@ do ( $ = jQuery ) ->
         <option value="guess">Auto</option>
       </select>
       Selector:
-      <input type="text" class="ha-bubble-selector" value="">
+      <input type="text" class="ha-bubble-selector" value=""><div class="ha-bubble-select-selector">*</div>
       <input type="button" class="ha-bubble-remove btn btn-danger" value="Remove">
     </div>
   """
@@ -126,7 +210,7 @@ do ( $ = jQuery ) ->
         docW = parseFloat(documentSize[0])
         docH = parseFloat(documentSize[1])
 
-        unless @position || @position is 'guess' #Guess mode
+        if not @position || @position is 'guess' #Guess mode
           ###
             x,y-------x2,y
             |          |
@@ -301,6 +385,7 @@ do ( $ = jQuery ) ->
       .off('mouseup', @handleMouseUpInstance)
 
       @elm.remove()
+      @targetArea.remove()
 
     buildEditMode:  ->
       self = this
@@ -317,17 +402,23 @@ do ( $ = jQuery ) ->
 
       @control.find('.ha-bubble-position').on 'change', ->
         self.position = $(this).val()
-        self.saveChanges()
         self.refresh()
+        self.saveChanges()
 
       @control.find('.ha-bubble-selector').on 'change', ->
         self.target = $(this).val()
-        self.saveChanges()
         self.refresh()
+        self.saveChanges()
 
       @control.find('.ha-bubble-remove').on 'click', ->
         HelpAnywhere.deleteItem(self)
 
+      @control.find('.ha-bubble-select-selector').on 'click', ->
+        HookingSystem.enable (selector) ->
+          self.position = 'auto' if self.position is 'free'
+          self.control.find('.ha-bubble-selector').val(selector).trigger('change')
+
+
       content = @elm.find('.ha-bubble-content')
 
       content
@@ -364,4 +455,6 @@ do ( $ = jQuery ) ->
         @saveChanges()
 
   #Register generator to generators list
-  HelpAnywhere.Component.register('Bubble', Bubble)
+  HelpAnywhere.Component.register('Bubble', Bubble)
+
+

data/app/assets/javascripts/help_anywhere/help_anywhere.js.coffee

@@ -63,8 +63,7 @@ do($ = jQuery) ->
         return true
       else
         return false
-    @hide: ->
-      @instance.closeHelpInterface()
+    @hide: -> @instance.closeHelpInterface()
     @edit: -> @show(yes)
 
     @saveElement: (elm) ->
@@ -84,12 +83,12 @@ do($ = jQuery) ->
       for [regexp, value] in routes
         regexp = '^' +
           regexp
-          .replace('/', '\\/')
-          .replace('.', '\\.')
-          .replace('**', '.*')
-          .replace('*', '[^\\/]*')
-          .replace('??', '(.*)')
-          .replace('?', '([^\\/]*)') + '$'
+          .replace(/\//g, '\\/')
+          .replace(/\./g, '\\.')
+          .replace(/\*/g, '[^\\/]*')
+          .replace(/\.\.\./g, '.*') #/[\.]{3}/ ??
+          .replace(/\?\?/g, '(.*)')
+          .replace(/\?/, '([^\\/]*)') + '$'
         @routes.push [new RegExp(regexp), value]
 
     @deleteItem: (elm) ->
@@ -206,9 +205,13 @@ do($ = jQuery) ->
       @helpInterface = null
 
     openHelpInterface: (@edit_mode=false)->
-      @helpInterface ?= $ HELP_INTERFACE_TEMPLATE(@pageList, @edit_mode)
+      return if @helpInterface?
+
+      @helpInterface = $ HELP_INTERFACE_TEMPLATE(@pageList, @edit_mode)
       @helpInterface.appendTo($("body"))
       @currentPage = 0
+      @elementsChanged = false
+
       self = this
 
       unless @edit_mode

data/app/assets/stylesheets/generators/bubble.css.scss

@@ -1,3 +1,17 @@
+.ha-hook-hover {
+  //border: solid 3px orange;
+  //box-sizing: border-box;
+  box-shadow: inset 0px 0px 0px 3px orange;
+}
+
+ .ha-bubble-target-selected {
+  border: solid 3px orange;
+  box-sizing: border-box;
+  display: 'block';
+  position: absolute;
+ }
+
+
 .ha-bubble-box {
   -webkit-touch-callout: none;
   -webkit-user-select: none;
@@ -125,6 +139,25 @@
       width: 100%;
     }
 
+    input.ha-bubble-selector {
+      width: 150px;
+      float: left;
+    }
+
+    .ha-bubble-select-selector {
+      cursor: pointer;
+      border: solid 1px white;
+      padding: 0px 7px;
+      background-color: #DDD;
+      font-weight: bold;
+      color: #333;
+      height: 19px;
+      float: right;
+      height: 17px;
+      margin-top: 2px;
+    }
+
+
     input {
       border: solid 1px #EEE;
     }

data/app/assets/stylesheets/help_anywhere_core_only.css.scss

@@ -122,18 +122,6 @@
   }
 }
 
- .ha-bubble-target-selected {
-  border: solid 3px orange;
-  box-sizing: border-box;
-  display: 'block';
-  position: absolute;
- }
-
-
-
-.ha-hover {
-  box-shadow: inset 0px 0px 1px 1px red, inset 0px 0px 2px 2px white !important;
-}
 
 #help-anywhere-selectbox {
   position: absolute;

data/lib/help-anywhere/configuration.rb

@@ -50,9 +50,9 @@ module HelpAnywhere
       self.match_data << [ regexp, result ]
     end
 
-    def ignore regexp
-      self.ignore_data << [ regexp, result ]
-    end
+    #def ignore regexp
+    #  self.ignore_data << [ regexp, result ]
+    #end
 
     def to_json *args
       arr = self.match_data + DEFAULTS_ROUTES

data/lib/help-anywhere/version.rb

@@ -1,3 +1,3 @@
 module HelpAnywhere
-  VERSION = "0.1.3"
+  VERSION = "0.1.4b"
 end

data/lib/tasks/help-anywhere_tasks.rake

@@ -1,4 +1,44 @@
-# desc "Explaining what the task does"
-# task :help-anywhere do
-#   # Task goes here
-# end
+#coding: utf-8
+
+namespace :help_anywhere do
+  desc "Generate everything you need to run help-anywhere plugin."
+  task :setup => ['help_anywhere:install:migrations'] do
+
+    relpath = File.join ["config", "initializers", "help_anywhere.rb"]
+
+    filepath = File.join Dir.pwd, relpath
+
+    if File.exists?(filepath)
+      puts "[X] Skipping `#{relpath}`: File already exists"
+    else
+      File.write filepath,
+<<-RUBY
+HelpAnywhere.configure do |config|
+
+  config.routes do |routes|
+    # Configure route between help pages and your controllers
+    # Use `*` to wilcard a path level, `...` to wilcard everything after
+    # and `?` to reuse a path level
+    # The second string is just an unique id for your help, you can use
+    # whatever you want!
+    #
+    # Example:
+    #
+    # routes.match '/articles/*/show...', 'article_show'
+    # routes.match '/admin/?/*/?...', 'admin_help_for_resource_$1_action_$2'
+  end
+
+  # Set here the method which is called to alloww or disallow edition mode
+  # You can create this method in your ApplicationController class.
+  # Default is a method which return always true: every one can edit help.
+  #
+  # config.edition_role = :can_user_edit_help?
+end
+RUBY
+
+      puts "[»] create `#{relpath}`"
+    end
+
+    puts "[»] Done! please add `require help_anywhere` in both application.js and application.css, run migrations, enjoy!"
+  end
+end

data/test/dummy/log/development.log

@@ -0,0 +1,31 @@
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+
+
+Started GET "/" for 127.0.0.1 at 2013-10-02 12:14:24 +0200
+
+ActionController::RoutingError (No route matches [GET] "/"):
+  actionpack (3.2.13) lib/action_dispatch/middleware/debug_exceptions.rb:21:in `call'
+  actionpack (3.2.13) lib/action_dispatch/middleware/show_exceptions.rb:56:in `call'
+  railties (3.2.13) lib/rails/rack/logger.rb:32:in `call_app'
+  railties (3.2.13) lib/rails/rack/logger.rb:16:in `block in call'
+  activesupport (3.2.13) lib/active_support/tagged_logging.rb:22:in `tagged'
+  railties (3.2.13) lib/rails/rack/logger.rb:16:in `call'
+  actionpack (3.2.13) lib/action_dispatch/middleware/request_id.rb:22:in `call'
+  rack (1.4.5) lib/rack/methodoverride.rb:21:in `call'
+  rack (1.4.5) lib/rack/runtime.rb:17:in `call'
+  activesupport (3.2.13) lib/active_support/cache/strategy/local_cache.rb:72:in `call'
+  rack (1.4.5) lib/rack/lock.rb:15:in `call'
+  actionpack (3.2.13) lib/action_dispatch/middleware/static.rb:63:in `call'
+  railties (3.2.13) lib/rails/engine.rb:479:in `call'
+  railties (3.2.13) lib/rails/application.rb:223:in `call'
+  rack (1.4.5) lib/rack/content_length.rb:14:in `call'
+  railties (3.2.13) lib/rails/rack/log_tailer.rb:17:in `call'
+  rack (1.4.5) lib/rack/handler/webrick.rb:59:in `service'
+  /home/yacine/.rvm/rubies/ruby-1.9.3-p362/lib/ruby/1.9.1/webrick/httpserver.rb:138:in `service'
+  /home/yacine/.rvm/rubies/ruby-1.9.3-p362/lib/ruby/1.9.1/webrick/httpserver.rb:94:in `run'
+  /home/yacine/.rvm/rubies/ruby-1.9.3-p362/lib/ruby/1.9.1/webrick/server.rb:191:in `block in start_thread'
+
+
+  Rendered /home/yacine/.rvm/gems/ruby-1.9.3-p362/gems/actionpack-3.2.13/lib/action_dispatch/middleware/templates/rescues/routing_error.erb within rescues/layout (4.9ms)

data/test/dummy/log/test.log

@@ -0,0 +1,11 @@
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+   (0.5ms)  begin transaction
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.4ms)  begin transaction
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.2ms)  begin transaction
+   (0.1ms)  rollback transaction

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: help-anywhere
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.1.4b
+  prerelease: 5
 platform: ruby
 authors:
 - Yacine Petitprez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +120,10 @@ files:
 - test/dummy/public/404.html
 - test/dummy/public/500.html
 - test/dummy/public/422.html
+- test/dummy/db/development.sqlite3
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/test.log
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/views/layouts/application.html.erb
@@ -127,16 +147,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1282744831073083889
+      hash: 1614212497889084903
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -1282744831073083889
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -166,6 +183,10 @@ test_files:
 - test/dummy/public/404.html
 - test/dummy/public/500.html
 - test/dummy/public/422.html
+- test/dummy/db/development.sqlite3
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/test.log
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/views/layouts/application.html.erb