html_safe_attribute 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in html_safe_attribute.gemspec
+gemspec

data/README.md

@@ -0,0 +1,49 @@
+# HtmlSaveAttribute
+
+## Description
+
+This `html_safe_attribute` extension provides the capabilities of
+declaring attributes as html_safe in your Rails models. 
+
+Sometimes information coming from the DB or other sources contains plain
+HTML and the content is completely trustable. This gem solves the
+problem of repeating `.html_safe` everywhere in your views for specific
+model attributes.
+
+It only applies when content in attribute is a String. When it is
+Numeric, it just does nothing.
+
+
+## Installation
+
+In your Gemfile:
+
+    gem 'html_safe_attribute'
+
+Or, from the command line:
+
+    gem install html_safe_attribute
+
+## Example
+
+Use `html_safe` method in the your model: 
+
+```ruby
+class Job < ActiveRecord::Base
+  html_safe :body
+end
+```
+
+## Contributing to `html_safe_attribute`
+ 
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+- Fork the project
+- Start a feature/bugfix branch
+- Commit and push until you are happy with your contribution
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Santi Bel, released under the MIT license

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run tests"
+task :default => :spec

data/html_safe_attribute.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "html_safe_attribute/version"
+
+Gem::Specification.new do |s|
+  s.name        = "html_safe_attribute"
+  s.version     = HtmlSafeAttribute::VERSION
+  s.authors     = ["Santi Bel"]
+  s.email       = ["santiago.bel@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Declare html_safe attributes in your Rails models}
+  s.description = %q{Use 'html_safe :attribute' to declare html_safe attributes in your Rails models}
+
+  s.rubyforge_project = "html_safe_attribute"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_development_dependency "rspec", "~> 2.13"
+
+  s.add_runtime_dependency "rails", "~> 3.2"
+end

data/lib/html_safe_attribute.rb

@@ -0,0 +1,10 @@
+require "html_safe_attribute/version"
+require 'active_support/core_ext'
+
+require File.join(File.dirname(__FILE__), "html_safe_attribute/railtie.rb")
+
+module HtmlSafeAttribute
+  autoload :Hook, File.join(File.dirname(__FILE__), "html_safe_attribute/hook")
+  autoload :InstanceMethods, File.join(File.dirname(__FILE__), "html_safe_attribute/instance_methods")
+end
+

data/lib/html_safe_attribute/hook.rb

@@ -0,0 +1,13 @@
+module HtmlSafeAttribute::Hook
+
+  def html_safe(attr_name)
+
+    define_method(:"#{attr_name.to_s}_with_html_safe") do
+      html_safe_if_string(send(:"#{attr_name}_without_html_safe"))
+    end
+    alias_method_chain attr_name.to_sym, :html_safe
+
+    include HtmlSafeAttribute::InstanceMethods
+  end
+
+end

data/lib/html_safe_attribute/instance_methods.rb

@@ -0,0 +1,13 @@
+module HtmlSafeAttribute::InstanceMethods
+
+  private
+
+  def html_safe_if_string(value)
+    if value.is_a? String
+      value.html_safe
+    else
+      value
+    end
+  end
+
+end

data/lib/html_safe_attribute/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'html_safe_attribute'
+
+begin
+  module HtmlSafeAttribute
+    class Railtie < Rails::Railtie
+      config.to_prepare do
+        Object.send(:extend, HtmlSafeAttribute::Hook)
+      end
+    end
+  end
+rescue
+  p $!, $!.message
+  raise $!
+end

data/lib/html_safe_attribute/version.rb

@@ -0,0 +1,3 @@
+module HtmlSafeAttribute
+  VERSION = "1.0.0"
+end

data/spec/html_safe_attribute_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+Object.send(:extend, HtmlSafeAttribute::Hook)
+
+class BasicModel
+  attr_accessor :my_attribute
+  html_safe :my_attribute
+end
+
+
+describe HtmlSafeAttribute do
+
+  describe "html_safe attributes" do
+
+    subject do 
+      model = BasicModel.new
+      model.my_attribute = "line 1 <br /> line 2"
+      model
+    end
+
+    it "must be html_safe for text" do
+      expect(subject.my_attribute.html_safe?).to be_true
+      expect(subject.my_attribute).to eq("line 1 <br /> line 2")
+    end
+
+    it "must be normal for numeric value" do
+      subject.my_attribute = 2
+      expect(subject.my_attribute).to eq(2)
+    end
+  end 
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'active_support'
+require 'html_safe_attribute'
+require 'rspec'
+require 'rspec/autorun'
+
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+end
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: html_safe_attribute
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Santi Bel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Use 'html_safe :attribute' to declare html_safe attributes in your Rails
+  models
+email:
+- santiago.bel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- html_safe_attribute.gemspec
+- lib/html_safe_attribute.rb
+- lib/html_safe_attribute/hook.rb
+- lib/html_safe_attribute/instance_methods.rb
+- lib/html_safe_attribute/railtie.rb
+- lib/html_safe_attribute/version.rb
+- spec/html_safe_attribute_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: html_safe_attribute
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Declare html_safe attributes in your Rails models
+test_files: []