inplace_editing 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f964eb6045e84d1fbd43d5f3624f26ef415a1ad7
+  data.tar.gz: 0ddf4472a4fff0c1f80ef222c6530e561061c371
+SHA512:
+  metadata.gz: b9d68ae52196d3d7b17587d5872eadc0c68f32e598cdb41e9d2da9520a33cd82b7f92e6edf7a041ef5a08a7857214b8baf09f5e1394b773448b2b79781e93d1d
+  data.tar.gz: 1ea88d2a8c65d85e6e4171880449e8df1924381cfcb376daf94a44a4225b10a543f0a7ba7bf4aef7117fb416a1a69c28731b7212c833bd49a9103a537929ce35

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hrangel@nucleo235.com.br. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inplace_editing.gemspec
+gemspec
+
+gem 'best_in_place', '~> 3.0.1'
+gem 'redcarpet', '>= 3.0.0'
+gem 'slim'
+gem 'slim-rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Henrique Rangel
+
+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,61 @@
+# InplaceEditing
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/inplace_editing`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inplace_editing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install inplace_editing
+
+Add to the controllers you want (e.g. ApplicationController)
+```ruby
+before_action :set_editor_config
+def set_editor_config
+  @can_edit = false # or true
+  @inplace_editing_mode = (@can_edit ? 'edit' : 'read')
+end
+```
+
+Don't forget to add scripts
+
+    //= require jquery
+    //= require best_in_place
+    //= require inplace_editing
+
+    $(document).ready(function() {
+      /* Activating Best In Place */
+      jQuery(".best_in_place").best_in_place();
+    });
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/inplace_editing. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/helpers/inplace_editing_helper.rb

@@ -0,0 +1,64 @@
+module InplaceEditingHelper
+  def should_show?(optional_string_value)
+    @can_edit || !optional_string_value.blank?
+  end
+
+  def optional_editor(localized_object, property)
+    render :layout => 'inplace_editing/optional', :locals => editor_locals(localized_object, property) do |locals|
+      yield locals
+    end
+  end
+
+  def only_valid_editor(localized_object, property)
+    render :layout => 'inplace_editing/only_valid', :locals => editor_locals(localized_object, property) do |locals|
+      yield locals
+    end
+  end
+
+  def text_editor(localized_object, property, place_holder = nil)
+    render partial: 'inplace_editing/text', :locals => editor_locals(localized_object, property, place_holder)
+  end
+
+  def string_editor(localized_object, property, place_holder = nil)
+    render partial: 'inplace_editing/string', :locals => editor_locals(localized_object, property, place_holder)
+  end
+
+  def image_editor(localized_object, property, place_holder = nil, default_value = nil)
+    render partial: 'inplace_editing/image', :locals => editor_locals(localized_object, property, place_holder, default_value)
+  end
+
+  def element_editor(localized_object, property, place_holder = nil, label = nil)
+    render layout: 'inplace/element', :locals => editor_locals(localized_object, property, place_holder, nil, label) do |locals|
+      yield locals
+    end
+  end
+
+  def editor_locals(localized_object, property, place_holder = nil, default_value = nil, label = nil)
+    { localized_object: localized_object, property: property, place_holder: place_holder, default_value: default_value, label: label }
+  end
+
+  def markdown(text, placeholder = '[texto aqui]')
+    return placeholder if !text
+    options = {
+      filter_html:     false,
+      hard_wrap:       true, 
+      link_attributes: { rel: 'nofollow', target: "_blank" },
+      space_after_headers: true, 
+      fenced_code_blocks: true,
+      tables: true
+    }
+
+    extensions = {
+      autolink:           true,
+      superscript:        true,
+      disable_indented_code_blocks: true
+    }
+
+    renderer = Redcarpet::Render::HTML.new(options)
+    markdown = Redcarpet::Markdown.new(renderer, extensions)
+
+    markdown.render(text).html_safe
+  end
+end
+
+# @inplace_editing_mode = tem que ser setado no after_action usando o @can_edit

data/app/views/inplace_editing/_element.html.slim

@@ -0,0 +1,2 @@
+= render layout: 'inplace_editing/' + @inplace_editing_mode + '/element', :locals => local_assigns do |args|
+  = yield(args)

data/app/views/inplace_editing/_image.html.slim

@@ -0,0 +1 @@
+= render partial: 'inplace_editing/' + @inplace_editing_mode + '/image', :locals => local_assigns

data/app/views/inplace_editing/_only_valid.html.slim

@@ -0,0 +1,2 @@
+- if localized_object[property]
+  = yield(local_assigns)

data/app/views/inplace_editing/_optional.html.slim

@@ -0,0 +1,2 @@
+- if should_show? localized_object[property]
+  = yield(local_assigns)

data/app/views/inplace_editing/_string.html.slim

@@ -0,0 +1 @@
+= render partial: 'inplace_editing/' + @inplace_editing_mode + '/string', :locals => local_assigns

data/app/views/inplace_editing/_text.html.slim

@@ -0,0 +1 @@
+= render partial: 'inplace_editing/' + @inplace_editing_mode + '/text', :locals => local_assigns

data/app/views/inplace_editing/edit/_element.html.slim

@@ -0,0 +1,6 @@
+.best_inplace_group
+  .best_before
+    - if local_assigns[:label]
+      label = local_assigns[:label] + ' '
+    = best_in_place localized_object, property, as: :input, :ok_button => 'Salvar', :cancel_button => 'Cancelar', :place_holder => (local_assigns[:place_holder] ? local_assigns[:place_holder] : "[texto aqui]")
+  = yield(local_assigns)

data/app/views/inplace_editing/edit/_image.html.slim

@@ -0,0 +1,41 @@
+- form_id = 'image_editor_' + localized_object.class.name + '' + localized_object.id.to_s + '_' + property.to_s
+- image_src = localized_object[property] ? localized_object.send(property.to_s + '_url') : local_assigns[:default_value]
+= simple_form_for(localized_object, html: {id:form_id, :multipart => true, novalidate: true }, :format => :json, :remote => true, authenticity_token: true) do |f|
+  = f.input_field property, as: :file, label: "Trocar Imagem", style: 'display:none'
+  = f.input property.to_s + "_cache", as: :hidden
+  .image-container
+    img.preview.editable-preview src="#{image_src}" style="#{image_src.blank? ? 'display:none' : ''}"
+    - if image_src.blank?
+      a.insert-image href="#" Clique para inserir imagem
+  .actions-container style="display:none;"
+    input.saveButton type="submit" href="#" value="Salvar"
+    input.cancelButton type="button" href="#" value="Cancelar"
+javascript:
+  $(document).ready(function() {
+    var form_id = "#{form_id}";
+    var imageEditor = asyncImageForm({
+      formSelector: 'form#' + form_id,
+      inputFileSelector: 'form#' + form_id + ' input[type=file]',
+      inputSubmitSelector: 'form#' + form_id + ' input[type=submit].saveButton',
+      imagePreviewSelector: 'form#' + form_id + ' img.editable-preview',
+      imageChangerSelector: 'form#' + form_id + ' img.preview, form#' + form_id + ' a.insert-image',
+      errorsGroup: '#{localized_object.class.name.downcase}',
+      events: {
+        imageChanged: function() {
+          $('form#' + form_id + ' a.insert-image').hide();
+          $('form#' + form_id + ' .actions-container').show();
+          $('form#' + form_id + ' .actions-container input').prop('disabled', false);
+        },
+        imageUploading: function() {
+          $('form#' + form_id + ' .actions-container input').prop('disabled', true)
+        },
+        imageUploadSuccess: function() {
+          $('form#' + form_id + ' .actions-container').hide();
+        },
+        imageUploadFail: function() {
+          $('form#' + form_id + ' .actions-container').show();
+          $('form#' + form_id + ' .actions-container input').prop('disabled', false)
+        }
+      }
+    });
+  });

data/app/views/inplace_editing/edit/_string.html.slim

@@ -0,0 +1 @@
+= best_in_place localized_object, property, as: :input, :ok_button => 'Salvar', :cancel_button => 'Cancelar', :place_holder => local_assigns[:place_holder] ? local_assigns[:place_holder] : "[troque o texto aqui]"

data/app/views/inplace_editing/edit/_text.html.slim

@@ -0,0 +1 @@
+= best_in_place localized_object, property, as: :textarea, class:'best_in_place_textarea', :place_holder => local_assigns[:place_holder] ? local_assigns[:place_holder] : "[texto aqui]", sanitize: false, :ok_button => 'Salvar', :cancel_button => 'Cancelar', :display_with  => lambda { |v| markdown(v, '[texto aqui]') }

data/app/views/inplace_editing/read/_element.html.slim

@@ -0,0 +1 @@
+= yield(local_assigns)

data/app/views/inplace_editing/read/_image.html.slim

@@ -0,0 +1 @@
+img alt="imagem" src="#{localized_object.send(property.to_s + '_url')}" /

data/app/views/inplace_editing/read/_string.html.slim

@@ -0,0 +1 @@
+= localized_object[property]

data/app/views/inplace_editing/read/_text.html.slim

@@ -0,0 +1 @@
+= markdown(localized_object[property])

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inplace_editing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inplace_editing.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inplace_editing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inplace_editing"
+  spec.version       = InplaceEditing::VERSION
+  spec.authors       = ["Henrique Rangel"]
+  spec.email         = ["dev@hrangel.com.br"]
+
+  spec.summary       = <<SUM
+  This front-end gem helps to allow users/managers to inplace edit string, text, images or other elements.
+  Besides that it helps to add optional or valid text only if a object's property exists.
+SUM
+  spec.description   = <<DESC
+  InplaceEditing is a jQuery and Best In Place script and a Rails helper that provides methods 
+  (string_editor, image_editor, text_editor, element_editor, optional_editor, only_valid_editor) to allow 
+  editing any ActiveRecord object's property (since it uses standard BestInPlace form).
+DESC
+  spec.homepage      = "https://github.com/hrangel/inplace_editing"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/assets/javascripts/inplace_editing.js

@@ -0,0 +1,57 @@
+function asyncImageForm(config) {
+  this.config = config;
+  // var config = {
+    // formSelector: 'form.async-republic-image',
+    // inputFileSelector: 'form.async-republic-image .input_addPictureButton',
+    // inputSubmitSelector: 'form.async-republic-image input[type=submit]',
+    // imagePreviewSelector: 'form.async-republic-image img.preview',
+    // imageChangerSelector: 'form.async-republic-image img.preview',
+    // errorsGroup: 'republic_image',
+    // events: {
+      // imageChanged: function() {},
+      // imageUploading: function() {},
+      // imageUploadSuccess: function() {},
+      // imageUploadFail: function() {}
+    // }
+  // }
+
+  function defaultPostImageSuccess() {
+    window.location.reload();
+    return false;
+  };
+
+  $(config.inputFileSelector).change(function(){
+    setImagePreview(this, $(config.imagePreviewSelector));
+    config.events.imageChanged(this);
+  });
+
+  $(config.imageChangerSelector).click(function(e){
+    $(config.inputFileSelector).click();
+  });
+
+  $(config.formSelector).submit(function (event) {
+    event.preventDefault();
+
+    //grab all form data  
+    var formData = new FormData($(this)[0]);
+
+    config.events.imageUploading(this);
+
+    $.ajax({
+        url: $(this).attr('action'),
+        type: $(this).attr('method'),
+        data: formData,
+        cache: false,
+        contentType: false,
+        processData: false,
+        success: function (responseData) {
+          config.events.imageUploadSuccess(responseData);
+        },
+        error: function () {
+          config.events.imageUploadFail(this);
+        }
+    });
+
+    return false;
+  });
+};

data/lib/inplace_editing/engine.rb

@@ -0,0 +1,4 @@
+module InplaceEditing
+  class Engine < Rails::Engine
+  end
+end

data/lib/inplace_editing/version.rb

@@ -0,0 +1,3 @@
+module InplaceEditing
+  VERSION = "0.1.3"
+end

data/lib/inplace_editing.rb

@@ -0,0 +1,7 @@
+require "inplace_editing/version"
+
+module InplaceEditing
+  # Your code goes here...
+end
+
+require 'inplace_editing/engine'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: inplace_editing
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Henrique Rangel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: "  InplaceEditing is a jQuery and Best In Place script and a Rails helper
+  that provides methods \n  (string_editor, image_editor, text_editor, element_editor,
+  optional_editor, only_valid_editor) to allow \n  editing any ActiveRecord object's
+  property (since it uses standard BestInPlace form).\n"
+email:
+- dev@hrangel.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/inplace_editing_helper.rb
+- app/views/inplace_editing/_element.html.slim
+- app/views/inplace_editing/_image.html.slim
+- app/views/inplace_editing/_only_valid.html.slim
+- app/views/inplace_editing/_optional.html.slim
+- app/views/inplace_editing/_string.html.slim
+- app/views/inplace_editing/_text.html.slim
+- app/views/inplace_editing/edit/_element.html.slim
+- app/views/inplace_editing/edit/_image.html.slim
+- app/views/inplace_editing/edit/_string.html.slim
+- app/views/inplace_editing/edit/_text.html.slim
+- app/views/inplace_editing/read/_element.html.slim
+- app/views/inplace_editing/read/_image.html.slim
+- app/views/inplace_editing/read/_string.html.slim
+- app/views/inplace_editing/read/_text.html.slim
+- bin/console
+- bin/setup
+- inplace_editing.gemspec
+- lib/assets/javascripts/inplace_editing.js
+- lib/inplace_editing.rb
+- lib/inplace_editing/engine.rb
+- lib/inplace_editing/version.rb
+homepage: https://github.com/hrangel/inplace_editing
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: This front-end gem helps to allow users/managers to inplace edit string,
+  text, images or other elements. Besides that it helps to add optional or valid text
+  only if a object's property exists.
+test_files: []