chardown_field 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0f9a9b4af88041066e39a4ce9f6ba1780634355
+  data.tar.gz: 00080e60b6f80eda7bbb62de51e785bd056696e3
+SHA512:
+  metadata.gz: 5d2cf59abab37045a2e5f85bfdc819527cd052e92f2812adb5a52eb9639e14b581285bb74f357f8651be55a747ca304046392be2cf0f6f545eea90ba0169dd99
+  data.tar.gz: 78a83cef58ad940feaf1221b7f03f0ab48976e06434eeeb48e0a20a808d6475d7da47ac1e1cb2718b397acfe21ce1b49c7b107f703c72494be26f593fe26f173

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Damian Borowski
+
+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.rdoc

@@ -0,0 +1,45 @@
+= ChardownField
+
+Extend your Rails forms with character countdown fields easy with just setting validations to your models.
+
+== Installation
+
+Installing this form extension is easy!
+
+Add the following to your Gemfile:
+
+    gem 'chardown_field'
+
+
+To your application.js:
+
+    //= require chardown_field
+
+
+To any of your models with maximum characters validation setup:
+
+    Include ChardownField
+
+
+And extend your forms by adding following attribute to your form_for/form_tag:
+
+    builder: ChardownFormExtension
+
+Or set it up as default for all the form by adding following line to application_helper.rb:
+
+    ActionView::Base.default_form_builder = ChardownFormExtension
+
+---
+
+After above simple setup your form fields will show 'Characters left:' countdown right under them. Remember that it automatically detects your validations in your model on the fields you chose to validate.
+
+You can style it to your needs by applying css to following classes:
+
+    .chardown-container # is a countdown wrapper and contains two elements:
+    
+
+    span # where 'Characters left:' text is displayed
+    
+
+    span.chardown # where you find number of left characters
+    

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChardownField'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,14 @@
+$(document).ready ->
+
+  $('.chardown').each ->
+    chardownField = $(this)
+    closestTextInputField = $(this).parents('.chardown-container').siblings('textarea, input')
+    textInputFieldMaxLength = closestTextInputField.prop('maxlength')
+    textInputFieldCurrentLength = closestTextInputField.text().length
+    chardownField.text(textInputFieldMaxLength-textInputFieldCurrentLength)
+
+    updateTextInputField = ->
+      chardownField.text(textInputFieldMaxLength - closestTextInputField.val().length)
+
+    closestTextInputField.on 'keydown', updateTextInputField
+    closestTextInputField.on 'keyup', updateTextInputField

data/app/helpers/chardown_form_extension.rb

@@ -0,0 +1,36 @@
+# This is my custom_form_builder to extend text_field and text_area with characters countdown.
+  class ChardownFormExtension < ActionView::Helpers::FormBuilder
+    def text_area(label, *args)
+      if @object.respond_to? :maxlength_validations
+        if @object.maxlength_validations.keys.include?(label)
+          options = args.extract_options!
+
+          super(label, *(args << options.merge(maxlength: @object.maxlength_validations[label]))) + @template.content_tag('div',
+                                  @template.content_tag('span', 'Characters left: ') +
+                                  @template.content_tag('span', @object.maxlength_validations[label], class: "chardown", id:"#{@object_name.to_s+'_'+label.to_s}", style: 'text-align: right;'),
+                                class: 'chardown-container', style: 'text-align: right;')
+        else
+          super(label, *args)
+        end
+      else
+        super(label, *args)
+      end
+    end
+
+    def text_field(label, *args)
+      if @object.respond_to? :maxlength_validations
+        if @object.maxlength_validations.keys.include?(label)
+          options = args.extract_options!
+
+          super(label, *(args << options.merge(maxlength: @object.maxlength_validations[label]))) + @template.content_tag('div',
+                                  @template.content_tag('span', 'Characters left: ') +
+                                  @template.content_tag('span', @object.maxlength_validations[label], class: "chardown", id:"#{@object_name.to_s+'_'+label.to_s}", style: 'text-align: right;'),
+                                class: 'chardown-container', style: 'text-align: right;')
+        else
+          super(label, *args)
+        end
+      else
+        super(label, *args)
+      end
+    end
+  end

data/config/routes.rb

@@ -0,0 +1,2 @@
+ChardownField::Engine.routes.draw do
+end

data/lib/chardown_field.rb

@@ -0,0 +1,28 @@
+require "chardown_field/engine"
+
+module ChardownField
+  extend ActiveSupport::Concern
+  # I am going to set class and instance methods for now. Don't know which will
+  # be more helpful at the moment.
+  module ClassMethods
+    def maxlength_validations
+
+      validators.select{ |v|
+        v.class.to_s.include?('Length')
+      }.map{ |limit|
+        [ limit.attributes.first, limit.options[:maximum] ]
+      }.to_h
+
+    end
+  end
+
+  def maxlength_validations
+
+    self.class.validators.select{ |v|
+      v.class.to_s.include?('Length')
+    }.map{ |limit|
+      [ limit.attributes.first, limit.options[:maximum] ]
+    }.to_h
+
+  end
+end

data/lib/chardown_field/engine.rb

@@ -0,0 +1,5 @@
+module ChardownField
+  class Engine < ::Rails::Engine
+    isolate_namespace ChardownField
+  end
+end

data/lib/chardown_field/version.rb

@@ -0,0 +1,3 @@
+module ChardownField
+  VERSION = "0.0.2"
+end

data/lib/tasks/chardown_field_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :chardown_field do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: chardown_field
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Damian Borowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jquery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Extend your Rails forms with character countdown fields easy with just
+  setting validations to your models.
+email:
+- dbjrsy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/assets/javascripts/chardown_field.js.coffee
+- app/helpers/chardown_form_extension.rb
+- config/routes.rb
+- lib/chardown_field.rb
+- lib/chardown_field/engine.rb
+- lib/chardown_field/version.rb
+- lib/tasks/chardown_field_tasks.rake
+homepage: https://github.com/dbjrsy/ChardownField
+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: Extend your Rails forms with character countdown fields easy with just setting
+  validations to your models.
+test_files: []