als_typograf 0.0.3 → 0.0.4

data/.gitignore

@@ -21,3 +21,5 @@ doc
 pkg
 
 ## PROJECT::SPECIFIC
+test/*.log
+test/*.db

data/README.rdoc

@@ -12,8 +12,18 @@ Example:
   require 'als_typograf'
   puts AlsTypograf.process('"Вы все еще кое-как верстаете в "Ворде"? - Тогда мы идем к вам!"')
 
+  class Article < ActiveRecord::Base
+    typograf :title, :use_br => false, :use_p => false
+    typograf :content
+    typograf :skills, :achievements, :description, :encoding => 'UTF-16'
+    typograf :foo => {:use_br => false},
+             :bar => {:use_p => false},
+             :baz => {:entity_type => AlsTypograf::NO_ENTITIES}
+  end
+
+
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/Rakefile

@@ -14,7 +14,6 @@ begin
     gem.add_dependency 'httparty', '>= 0.4.5'
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     gem.add_development_dependency "yard", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -41,9 +40,30 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
 
-task :default => :test
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
 
 begin
   require 'yard'
@@ -53,3 +73,8 @@ rescue LoadError
     abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
 end
+
+task :test => :check_dependencies
+task :default => :test
+desc 'Push release to github and gemcutter and install gem in the system'
+task :push => %w(release gemcutter:release install)

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/als_typograf.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{als_typograf}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexander Semyonov"]
-  s.date = %q{2009-11-24}
+  s.date = %q{2009-11-26}
   s.description = %q{ruby-implementation of ArtLebedevStudio.RemoteTypograf class (web-service client)}
   s.email = %q{rotuka@rotuka.com}
   s.extra_rdoc_files = [
@@ -25,8 +25,14 @@ Gem::Specification.new do |s|
      "VERSION",
      "als_typograf.gemspec",
      "lib/als_typograf.rb",
+     "lib/als_typograf/active_record.rb",
+     "lib/als_typograf/request.rb",
+     "rails/init.rb",
+     "test/database.yml",
      "test/helper.rb",
-     "test/test_als_typograf.rb"
+     "test/schema.rb",
+     "test/test_als_typograf.rb",
+     "test/test_article.rb"
   ]
   s.homepage = %q{http://github.com/rotuka/als_typograf}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -35,7 +41,9 @@ Gem::Specification.new do |s|
   s.summary = %q{ArtLebedevStudio.RemoteTypograf}
   s.test_files = [
     "test/helper.rb",
-     "test/test_als_typograf.rb"
+     "test/test_als_typograf.rb",
+     "test/schema.rb",
+     "test/test_article.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/als_typograf.rb

@@ -2,54 +2,18 @@ $KCODE = 'u'
 
 require 'activesupport'
 require 'httparty'
+require 'als_typograf/request'
 
 # ruby-implementation of ArtLebedevStudio.RemoteTypograf class (web-service client)
 # @author Alexander Semyonov
 module AlsTypograf
-  # The request class
-  class Request
-    include HTTParty
-    base_uri 'typograf.artlebedev.ru'
-    format :xml
-    headers('Content-Type' => 'text/xml',
-            'Host' => 'typograf.artlebedev.ru',
-            'SOAPAction' => '"http://typograf.artlebedev.ru/webservices/ProcessText"')
-
-    # Process text with remote web-service
-    # @param [String] text to process
-    # @param [Hash] options for web-service
-    def process_text(text, options = {})
-      prepared_text = text.gsub(/&/, '&').
-                           gsub(/</, '&lt;').
-                           gsub(/>/, '&gt;')
-      soap_request = <<-END_SOAP
-<?xml version="1.0" encoding="#{options[:encoding]}" ?>
-<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
-<soap:Body>
- <ProcessText xmlns="http://typograf.artlebedev.ru/webservices/">
-  <text>#{prepared_text}</text>
-     <entityType>#{options[:entity_type]}</entityType>
-     <useBr>#{options[:use_br]}</useBr>
-     <useP>#{options[:use_p]}</useP>
-     <maxNobr>#{options[:max_nobr]}</maxNobr>
-  </ProcessText>
- </soap:Body>
-</soap:Envelope>
-      END_SOAP
-      response = self.class.post('/webservices/typograf.asmx',
-                                 :body => soap_request)
-      response['soap:Envelope']['soap:Body']['ProcessTextResponse']['ProcessTextResult'].
-        gsub(/&amp;/, '&').
-        gsub(/&lt;/, '<').
-        gsub(/&gt;/, '>').
-        gsub(/\t$/, '')
-    rescue
-      text
-    end
-  end
+  HTML_ENTITIES = 1
+  XML_ENTITIES = 2
+  NO_ENTITIES = 3
+  MIXED_ENTITIES = 4
 
   DEFAULT_OPTIONS = {
-    :entity_type => 4,
+    :entity_type => NO_ENTITIES,
     :use_br => 1,
     :use_p => 1,
     :max_nobr => 3,
@@ -61,14 +25,14 @@ module AlsTypograf
   @@options = DEFAULT_OPTIONS.dup
 
   # Get a global AlsTypograf option
-  # @param [String, Symbol] option name
+  # @param [String, Symbol] param option name
   def self.[](param)
     self.options[param.to_sym]
   end
 
   # Set a global AlsTypograf option
-  # @param [String, Symbol] option name
-  # @param [Numeric, String] value for the option
+  # @param [String, Symbol] param option name
+  # @param [Numeric, String] value value for the option
   def self.[]=(param, value)
     self.options[param.to_sym] = value
   end
@@ -80,38 +44,38 @@ module AlsTypograf
 
   # Set option #entity_type to HTML (e. g. &nbsp;, &mdash;)
   def self.html_entities!
-    self[:entity_type] = 1
+    self[:entity_type] = HTML_ENTITIES
   end
 
   # Set option #entity_type to XML (e. g. &#169;, &#155;)
   def self.xml_entities!
-    self[:entity_type] = 2
+    self[:entity_type] = XML_ENTITIES
   end
 
   # Set option #entity_type to nothing (e. g. —, ©, ×)
   def self.no_entities!
-    self[:entity_type] = 3
+    self[:entity_type] = NO_ENTITIES
   end
 
   # Set option #entity_type to mixed (e. g. &#169;, &nbsp;)
   def self.mixed_entities!
-    self[:entity_type] = 4
+    self[:entity_type] = MIXED_ENTITIES
   end
 
   # Option to replace \n with  +<br />+
-  # @param [Boolean] to use +<br />+ or not
+  # @param [Boolean] value to use +<br />+ or not
   def self.use_br=(value)
     self[:use_br] = value ? 1 : 0
   end
 
   # Option to wrap paragraphs with  +<p></p>+
-  # @param [Boolean] to wrap para or not
+  # @param [Boolean] value to wrap para or not
   def self.use_p=(value)
     self[:use_p] = value ? 1 : 0
   end
 
   # How many symbols around dash to surround with +<nobr>+ tag
-  # @param [Numeric, Boolean] symbols count
+  # @param [Numeric, Boolean] value symbols count
   def self.max_nobr=(value)
     self[:max_nobr] = value ? value : 0
   end
@@ -122,17 +86,24 @@ module AlsTypograf
       self[$1.to_sym] = args.first
     when /^(#{VALID_OPTIONS})$/
       self[method_name.to_sym]
+    else
+      super(method_name, *args)
     end
   end
 
   # Process text with Typograf web-service
-  # @param [String] text to process
+  # @param [String] text text to process
   # @param [Hash] custom_options the options to process current text with
-  # @option custom_options [String] :entity_type Type of entities to use in processed text
-  # @option custom_options [String] :use_br Whether or not to use +<br />+
-  # @option custom_options [String] :use_p Whether or not to surround paras with +<p></p>+
-  # @option custom_options [String] :encoding Encoding of text
+  # @option custom_options [String] :entity_type (NO_ENTITIES) Type of entities to use in processed text
+  # @option custom_options [String] :use_br (1) Whether or not to use +<br />+
+  # @option custom_options [String] :use_p (1) Whether or not to surround paras with +<p></p>+
+  # @option custom_options [String] :max_nobr (3) How many symbols around dash to surround with +<nobr>+ tag
+  # @option custom_options [String] :encoding ('UTF-8') Encoding of text
   def self.process(text, custom_options = {})
     Request.new.process_text(text, custom_options.reverse_merge(options))
   end
 end
+
+if defined? ActiveRecord
+  require 'als_typograf/active_record'
+end

data/lib/als_typograf/active_record.rb

@@ -0,0 +1,57 @@
+module AlsTypograf
+  module ActiveRecord
+    # Run AlsTypograf#process on configured columns.
+    # Used to run as before_validation filter (automaticaly added on ActiveRecord::Base.typograf)
+    def typograf_current_fields
+      self.class.typograf_fields.each do |column, options|
+        send(:"#{column}=",
+             AlsTypograf.process(send(column).to_s,
+                                 options))
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  # Specify columns to typograf
+  # @overload typograf(column_name, options)
+  #   Typograf only specified column with specified or default options
+  #   @example typograf column with default options
+  #     typograf :content # will typograf +content+ with default AlsTypograf options
+  #   @example typograf column with custom options
+  #     typograf :title, :use_br => false # will typograf +title+ without replacing +\n+ with <br />
+  #   @param [String, Symbol] column_name name of the column to typograf
+  #   @param [Hash] options custom options to AlsTypograf#process method
+  # @overload typograf(column1, column2, ..., options)
+  #   Typograf every specified columns with default options
+  #   @example typograf columns with common custom options
+  #     typograf :skills, :achievements, :description, :encoding => 'CP1251'
+  #   @param [String, Symbol] column1 first column name
+  #   @param [String, Symbol] column2 next column name
+  #   @param [String, Symbol] ... specify all columns, you need
+  #   @param [Hash] options options to AlsTypograf#process method for all specified fields
+  # @overload typograf(columns_with_options)
+  #   Typograf specified columns with specified options
+  #   @example typograf specified columns with specified options
+  #     typograf :foo => {:use_br => false}, :bar => {:use_p => false}
+  #   @param [Hash] columns_with_options column names with correspond options to AlsTypograf#process method
+  def self.typograf(*columns)
+    unless respond_to?(:typograf_fields)
+      cattr_accessor :typograf_fields
+      self.typograf_fields = {}
+      before_validation :typograf_current_fields
+      include AlsTypograf::ActiveRecord
+    end
+
+    common_options = columns.extract_options!
+    if columns == [] # There was an columns_with_options variant
+      common_options.each do |column, custom_options|
+        typograf_fields[column.to_sym] = custom_options
+      end
+    else
+      columns.each do |column|
+        typograf_fields[column.to_sym] = common_options
+      end
+    end
+  end
+end

data/lib/als_typograf/request.rb

@@ -0,0 +1,35 @@
+module AlsTypograf
+  # The request class
+  class Request
+    include HTTParty
+    base_uri 'typograf.artlebedev.ru'
+    format :xml
+    headers('Content-Type' => 'text/xml',
+            'Host' => 'typograf.artlebedev.ru',
+            'SOAPAction' => '"http://typograf.artlebedev.ru/webservices/ProcessText"')
+
+    # Process text with remote web-service
+    # @param [String] text text to process
+    # @param [Hash] options options for web-service
+    def process_text(text, options = {})
+      soap_request = <<-END_SOAP
+<?xml version="1.0" encoding="#{options[:encoding]}" ?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+<soap:Body>
+ <ProcessText xmlns="http://typograf.artlebedev.ru/webservices/">
+  <text>#{text.gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;')}</text>
+     <entityType>#{options[:entity_type]}</entityType>
+     <useBr>#{options[:use_br]}</useBr>
+     <useP>#{options[:use_p]}</useP>
+     <maxNobr>#{options[:max_nobr]}</maxNobr>
+  </ProcessText>
+ </soap:Body>
+</soap:Envelope>
+      END_SOAP
+      response = self.class.post('/webservices/typograf.asmx', :body => soap_request)
+      response['soap:Envelope']['soap:Body']['ProcessTextResponse']['ProcessTextResult'].gsub(/&amp;/, '&').gsub(/&lt;/, '<').gsub(/&gt;/, '>').gsub(/\t$/, '')
+    rescue ::Exception => exception
+      return text
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'als_typograf'

data/test/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  :adapter: sqlite
+  :database: vendor/plugins/als_typograf/test/als_typograf_plugin.sqlite.db
+
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/als_typograf/test/als_typograf_plugin.sqlite3.db
+
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: als_typograf_plugin_test
+  :min_messages: ERROR
+
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: password
+  :database: als_typograf_plugin_test

data/test/helper.rb

@@ -1,7 +1,11 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.join(File.dirname(__FILE__), '../../../..')
+
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'redgreen' rescue nil
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -20,3 +24,33 @@ class Test::Unit::TestCase
     AlsTypograf.process(text)
   end
 end
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+        'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+          'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../rails/init.rb'
+end
+

data/test/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :articles, :force => true do |t|
+    t.string :title
+    t.text :content, :skills, :achievements, :description,
+      :foo, :bar, :baz
+  end
+end

data/test/test_als_typograf.rb

@@ -1,18 +1,23 @@
 require 'helper'
 
 class TestAlsTypograf < Test::Unit::TestCase
+
+  class Article < ActiveRecord::Base
+  end
+
   # TODO: need more tests or not?
   context 'with default configuration' do
     setup { AlsTypograf.default_options! }
     process_assertions({
-      '- Это "Типограф"?' => "<p>&#151; Это &laquo;Типограф&raquo;?</p>",
+      '- Это "Типограф"?' => "<p>— Это «Типограф»?</p>",
     })
   end
 
   context 'no p' do
     setup { AlsTypograf.use_p = false }
     process_assertions({
-      '- Это "Типограф"?' => "&#151; Это &laquo;Типограф&raquo;?",
+      '- Это "Типограф"?' => "— Это «Типограф»?",
     })
   end
+
 end

data/test/test_article.rb

@@ -0,0 +1,38 @@
+require 'helper'
+require 'als_typograf/active_record'
+require 'pp'
+
+load_schema
+
+class Article < ActiveRecord::Base
+  typograf(:content)
+  typograf(:title => {:use_p => false, :use_br => false})
+  typograf(:skills, :achievements, :description, :use_br => false)
+end
+
+class TestArticle < Test::Unit::TestCase
+  def self.described_type; Article end
+
+  should_have_class_methods :typograf
+  should_have_instance_methods :typograf_fields
+
+  should 'load schema correctly' do
+    assert_equal [], Article.all
+  end
+
+  context 'with an Article' do
+    setup do
+      @article = Article.create(:title => '- Does it "Article"?',
+                                :content => 'Yes, this is an "Article"...')
+      AlsTypograf.default_options!
+    end
+
+    should 'typograf article’s content with default options' do
+      assert_equal '<p>Yes, this is an «Article»…</p>', @article.content
+    end
+
+    should 'typograf article’s title with custom options' do
+      assert_equal '— Does it «Article»?', @article.title
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: als_typograf
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Alexander Semyonov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 +03:00
+date: 2009-11-26 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,8 +70,14 @@ files:
 - VERSION
 - als_typograf.gemspec
 - lib/als_typograf.rb
+- lib/als_typograf/active_record.rb
+- lib/als_typograf/request.rb
+- rails/init.rb
+- test/database.yml
 - test/helper.rb
+- test/schema.rb
 - test/test_als_typograf.rb
+- test/test_article.rb
 has_rdoc: true
 homepage: http://github.com/rotuka/als_typograf
 licenses: []
@@ -103,3 +109,5 @@ summary: ArtLebedevStudio.RemoteTypograf
 test_files: 
 - test/helper.rb
 - test/test_als_typograf.rb
+- test/schema.rb
+- test/test_article.rb