frendms-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fa8eb3368bc807fbf368b087a7ccdcda1d616b9
+  data.tar.gz: 3c4723051cca5750cb487c9492e12f57df158b44
+SHA512:
+  metadata.gz: 0e65eeec3ff6f68da76ba971ee77a25438d2a8d3e494845d582f5737c76bb662c419b5c34595ea0ff6168b640ec0afb55d651e362318a60cac12499f7341fc19
+  data.tar.gz: 2cc25abb35556c456b37be3e37c575624359554e85437a89a7ac0ace397006024fa15c4c07bafe3c0cdab5eabbfe8f93f4d6fcb5df3dfaaaed106e5406c3a7b9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in frendms-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tyson Holub
+
+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,79 @@
+# Frendms
+
+The Rails Frond End Management System.
+
+Use this gem to modify the front end of any website on the fly via ajax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'frendms-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install frendms-rails
+
+## Usage
+
+After installation execute:
+
+    $ rails g frendms
+
+This will generate the migration for the elements table used to store element values. Use with Devise authentication to update front end elements on the fly via ajax. When logged in, any child elements of class "frender" with the class "frend" will be editable.
+
+Add to the bottom of your layout file
+
+```ruby
+<% if user_signed_in? %>
+<script>
+	$(document).ready(function(){
+		$('.frend').addClass('enabled')
+	})
+</script>
+<% end %>
+```
+
+Example of an editable layout:
+
+```html
+<html>
+<body>
+  <section class="frender" id="header">
+    <header class="frend">I'm an editable header</header>
+  </section>
+
+  <section class="frender" id="<%= "#{controller_name}-#{action_name}" %>">
+    <%= yield %> <!-- yield frend class elements per controller action -->
+  </section>
+
+  <section class="frender" id="footer">
+    <footer class="frend">I'm an editable footer</footer>
+  </section>
+</body>
+
+<% if user_signed_in? %>
+<script>
+	$(document).ready(function(){
+		$('.frend').addClass('enabled')
+	})
+</script>
+<% end %>
+
+</html>  
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/frendms-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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 @@
+require "bundler/gem_tasks"

data/app/controllers/frendms/element_controller.rb

@@ -0,0 +1,47 @@
+module Frendms
+  class ElementController < ::ApplicationController
+
+    def get_elements
+      e = Element.where('frender = ?', params[:frender])
+      respond_to do |format|
+        format.json { render :json => e.to_json(:only => [:elementId, :text]) }
+      end
+    end
+
+    def update_element
+      if user_signed_in?
+        e = Element.find_by(:elementId => params[:id], :frender => params[:frender])
+
+        if(params[:text].length > 0)
+          if e.nil?
+            e = Element.new
+            e.frender = params[:frender]
+            e.elementId = params[:id]
+          end
+          e.text = params[:text]
+          e.save
+
+          respond_to do |format|
+            format.json { render :json => e.to_json }
+          end
+        else
+          if not e.nil?
+            e.delete
+            respond_to do |format|
+              format.json { render :json => { 'resp' => "deleted element record for element id '#{params[:id]}'" } }
+            end
+          else
+            respond_to do |format|
+              format.json { render :json => { 'resp' => 'nothing to do' } }
+            end
+          end
+        end
+      else
+        respond_to do |format|
+          format.json { render :json => { 'error' => 'you must be logged in to commit changes' } }
+        end
+      end
+    end
+
+  end
+end

data/app/models/frendms/element.rb

@@ -0,0 +1,4 @@
+module Frendms
+  class Element < ActiveRecord::Base
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "frendms/rails"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  get '/element/all' => 'frendms/element#get_elements'
+  put '/element/update' => 'frendms/element#update_element'
+end

data/frendms-rails.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+# stub: frendms-rails 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "frendms-rails"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  # s.metadata = { "allowed_push_host" => "TODO: Set to 'http://mygemserver.com'" } if s.respond_to? :metadata=
+  s.require_paths = ["lib"]
+  s.authors = ["Tyson Holub"]
+  s.bindir = "exe"
+  s.date = "2016-10-10"
+  s.description = "Click a html element to make it an editable textarea. Changes are saved to the database via ajax. When the page is loaded the changes will be injected into that element."
+  s.email = ["tyson@tysonholub.com"]
+  s.files = [".gitignore", ".travis.yml", "CODE_OF_CONDUCT.md", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "app/controllers/frendms/element_controller.rb", "app/models/frendms/element.rb", "bin/console", "bin/setup", "config/routes.rb", "frendms-rails.gemspec", "lib/frendms/rails.rb", "lib/frendms/rails/version.rb", "lib/generators/frendms/frendms_generator.rb", "lib/generators/frendms/templates/migration.rb", "vendor/assets/javascripts/dompath.js", "vendor/assets/javascripts/frendms.js", "vendor/assets/stylesheets/frendms.css"]
+  s.homepage = "http://frendms.tysonholub.com"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "The Front End Management System"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.10"])
+      s.add_development_dependency(%q<rake>, ["~> 10.0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.10"])
+      s.add_dependency(%q<rake>, ["~> 10.0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.10"])
+    s.add_dependency(%q<rake>, ["~> 10.0"])
+  end
+end

data/lib/frendms/rails.rb

@@ -0,0 +1,8 @@
+require "frendms/rails/version"
+
+module Frendms
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/frendms/rails/version.rb

@@ -0,0 +1,5 @@
+module Frendms
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/generators/frendms/frendms_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class FrendmsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_elements_table.rb'
+  end
+end

data/lib/generators/frendms/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateElementsTable < ActiveRecord::Migration
+  def self.up
+    create_table :elements do |t|
+      t.string :elementId
+      t.string :frender
+      t.text :text
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :elements
+  end
+end

data/vendor/assets/javascripts/dompath.js

@@ -0,0 +1,30 @@
+;(function($) {
+    $.fn.dompath = function(config) {
+        var dompath = [],
+            node,
+			sender = $(this)[0], 
+			tag;
+		
+		// dompath.push(_buildTag(sender))
+
+		for (node = sender.parentNode; node; node = node.parentNode) {
+			if(node.tagName.toLowerCase() == "html") break;
+			dompath.push(_buildTag(node))
+		}
+        
+		function _buildTag(node) {
+			tag = node.tagName.toLowerCase();
+			
+			if (node.id) {
+				tag += "#" + node.id.replace(/ /g, '#');
+			}
+			else if (node.className) {
+				tag += "." + node.className.replace(/ /g, '.');
+			}
+			
+			return tag;
+		}
+		
+		return dompath.reverse().join(" ");
+    }
+})(jQuery);

data/vendor/assets/javascripts/frendms.js

@@ -0,0 +1,98 @@
+function getElements(frender){
+	$.ajax({
+		url : '/element/all',
+		type : 'GET',
+		data : { frender : frender },
+		dataType : 'json',
+		beforeSend : function() {
+
+		},
+		success : function(data) {
+			console.log(data);
+			$.each(data, function(i, element){
+				if(element['elementId'].length > 1){
+					$.each($(element['elementId']), function(j, inner){
+						if($(inner).dompath().split(' ').length + 1 == element['elementId'].split(' ').length){
+							$(inner).html(element['text'])
+						}
+					})
+				} else {
+					$(element['elementId']).html(element['text'])
+				}
+			})
+			$('.frend').show()
+		},
+		complete : function(data) {
+		    if (location.hash) {
+		        location.href = location.hash;
+		    }
+		},
+		error : function(XMLHttpRequest, textStatus, errorThrown){
+		}
+	})
+}
+
+function updateElement(element){
+	element.parent().toggleClass('focused');
+	var id = element.dompath().replace('.enabled', '');
+	var text = element.val().trim();
+	var frender = element.closest('.frender').attr('id');
+
+	$.ajax({
+		url : '/element/update',
+		data : { frender : frender, text : text, id : id },
+		type : 'PUT',
+		dataType : 'json',
+		success : function(data) {
+			$.notify('Successfully updated element', 'success')
+		},
+		error : function(XMLHttpRequest, textStatus, errorThrown){
+			$.notify('Failed to update element', 'error')
+		}
+	});
+}
+
+$(window).load(function(){
+
+	$('.frender').each(function(index, frender){
+		getElements(frender.id);
+	});
+
+	var value = '';
+	$('.frend.enabled').on('click', function(){
+		if(($(this).find('textarea').prop('tagName')) != 'TEXTAREA'){
+			var height = $(this).height()
+			var width = $(this).width()
+			$(this).toggleClass('focused')
+			var content = $(this).text()
+			value = content
+			$(this).html('<textarea id="box-in-frend" class="frend-input-box" />')
+			$('#box-in-frend').val(content.trim())
+			$(this).find('.frend-input-box').css({
+				'height' : height + 'px',
+				'width' : width + 'px'
+			}).select()
+		}
+	})
+
+	$('.frend.enabled').on('blur', 'textarea', function(){
+		if($(this).val() != value){
+			updateElement($(this))
+		}
+
+		if($(this).val().length < 1){
+			$(this).parent().html($(this).parent().dompath().replace('.enabled', ''))
+		} else {
+			$(this).parent().html($(this).val())
+		}
+		$('.frend').removeClass('focused')
+	})
+
+	$('.frend.enabled').on('keyup', 'textarea', function(){
+		var h = $(this).height()
+		$(this).css('height', '0px')
+		var sh = $(this).prop('scrollHeight')
+		var minh = $(this).css('min-height').replace('px', '')
+		$(this).css('height', Math.max(sh,minh)+'px')
+	})
+})

data/vendor/assets/stylesheets/frendms.css

@@ -0,0 +1,34 @@
+.frend{
+	display:none;
+	white-space:pre-wrap;
+}
+
+.frend-input-box{
+	background-color: transparent;
+	border: none;
+	outline:none;
+	font:inherit;
+	color:inherit;
+	text-align:inherit;
+	text-transform:inherit;
+	line-height:1em;
+	letter-spacing:inherit;
+	white-space:inherit;
+	vertical-align:inherit;
+	padding:0;
+	margin:0;
+	resize:none;
+}
+
+.frend.enabled{
+	word-wrap:break-word;
+}
+
+.frend.enabled.focused{
+	outline:1px dotted green;
+}
+
+.frend.enabled:hover{
+	cursor:pointer;
+	outline:1px dotted green;
+}

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: frendms-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyson Holub
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: Click a html element to make it an editable textarea. Changes are saved
+  to the database via ajax. When the page is loaded the changes will be injected into
+  that element.
+email:
+- tyson@tysonholub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/frendms/element_controller.rb
+- app/models/frendms/element.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- frendms-rails.gemspec
+- lib/frendms/rails.rb
+- lib/frendms/rails/version.rb
+- lib/generators/frendms/frendms_generator.rb
+- lib/generators/frendms/templates/migration.rb
+- vendor/assets/javascripts/dompath.js
+- vendor/assets/javascripts/frendms.js
+- vendor/assets/stylesheets/frendms.css
+homepage: http://frendms.tysonholub.com
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: The Front End Management System
+test_files: []