als_typograf 0.0.1 → 0.0.2

data/.gitignore

@@ -14,8 +14,10 @@ tmtags
 *.swp
 
 ## PROJECT::GENERAL
+.yardoc
 coverage
 rdoc
+doc
 pkg
 
 ## PROJECT::SPECIFIC

data/README.rdoc

@@ -1,6 +1,16 @@
-= als_typograf
+= AlsTypograf
 
-Description goes here.
+ruby-implementation of ArtLebedevStudio.RemoteTypograf class (web-service client)
+
+* Typograf homepage: http://typograf.artlebedev.ru/
+* Web-service address: http://typograf.artlebedev.ru/webservices/typograf.asmx
+* WSDL-description: http://typograf.artlebedev.ru/webservices/typograf.asmx?WSDL
+
+Default charset: UTF-8
+
+Example:
+  require 'als_typograf'
+  puts AlsTypograf.process('"Вы все еще кое-как верстаете в "Ворде"? - Тогда мы идем к вам!"')
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/als_typograf.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{als_typograf}
+  s.version = "0.0.2"
+
+  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.description = %q{ruby-implementation of ArtLebedevStudio.RemoteTypograf class (web-service client)}
+  s.email = %q{rotuka@rotuka.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "als_typograf.gemspec",
+     "lib/als_typograf.rb",
+     "test/helper.rb",
+     "test/test_als_typograf.rb"
+  ]
+  s.homepage = %q{http://github.com/rotuka/als_typograf}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ArtLebedevStudio.RemoteTypograf}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_als_typograf.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/als_typograf.rb

@@ -3,7 +3,10 @@ $KCODE = 'u'
 require 'activesupport'
 require 'httparty'
 
+# 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'
@@ -12,30 +15,19 @@ module AlsTypograf
             '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;')
-      response = self.class.post('/webservices/typograf.asmx',
-                                 :body => soap_request(prepared_text, options))
-      result = response['soap:Envelope']['soap:Body']['ProcessTextResponse']['ProcessTextResult'].
-               gsub(/&amp;/, '&').
-               gsub(/&lt;/, '<').
-               gsub(/&gt;/, '>').
-               gsub(/\t$/, '')
-    rescue
-      text
-    end
-
-  protected
-
-    def soap_request(text, options = {})
-      soap_body = <<-END_SOAP
+      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}</text>
+  <text>#{prepared_text}</text>
      <entityType>#{options[:entity_type]}</entityType>
      <useBr>#{options[:use_br]}</useBr>
      <useP>#{options[:use_p]}</useP>
@@ -44,11 +36,18 @@ module AlsTypograf
  </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
 
-  mattr_accessor :options
-
   DEFAULT_OPTIONS = {
     :entity_type => 4,
     :use_br => 1,
@@ -56,42 +55,84 @@ module AlsTypograf
     :max_nobr => 3,
     :encoding => 'UTF-8'
   }
+  VALID_OPTIONS = DEFAULT_OPTIONS.keys.join('|')
+
+  mattr_accessor :options
   @@options = DEFAULT_OPTIONS.dup
 
+  # Get a global AlsTypograf option
+  # @param [String, Symbol] 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
   def self.[]=(param, value)
-    self.options[param] = value
+    self.options[param.to_sym] = value
   end
 
+  # Reset default options
   def self.default_options!
     @@options = DEFAULT_OPTIONS.dup
   end
 
+  # Set option #entity_type to HTML (e. g. &nbsp;, &mdash;)
   def self.html_entities!
     self[:entity_type] = 1
   end
 
+  # Set option #entity_type to XML (e. g. &#169;, &#155;)
   def self.xml_entities!
     self[:entity_type] = 2
   end
 
+  # Set option #entity_type to nothing (e. g. —, ©, ×)
   def self.no_entities!
     self[:entity_type] = 3
   end
 
+  # Set option #entity_type to mixed (e. g. &#169;, &nbsp;)
   def self.mixed_entities!
     self[:entity_type] = 4
   end
 
-  def self.p!(value)
+  # Option to replace \n with  +<br />+
+  # @param [Boolean] 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
+  def self.use_p=(value)
     self[:use_p] = value ? 1 : 0
   end
 
-  def self.nobr!(value)
+  # How many symbols around dash to surround with +<nobr>+ tag
+  # @param [Numeric, Boolean] symbols count
+  def self.max_nobr=(value)
     self[:max_nobr] = value ? value : 0
   end
 
-  def self.process(text)
-    Request.new.process_text(text, options)
+  def self.method_missing(method_name, *args)
+    case method_name.to_s
+    when /^(#{VALID_OPTIONS})=$/
+      self[$1.to_sym] = args.first
+    when /^(#{VALID_OPTIONS})$/
+      self[method_name.to_sym]
+    end
+  end
+
+  # Process text with Typograf web-service
+  # @param [String] 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
+  def self.process(text, custom_options = {})
+    Request.new.process_text(text, custom_options.reverse_merge(options))
   end
 end

data/test/test_als_typograf.rb

@@ -10,7 +10,7 @@ class TestAlsTypograf < Test::Unit::TestCase
   end
 
   context 'no p' do
-    setup { AlsTypograf.p!(false) }
+    setup { AlsTypograf.use_p = false }
     process_assertions({
       '- Это "Типограф"?' => "&#151; Это &laquo;Типограф&raquo;?",
     })

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: als_typograf
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alexander Semyonov
@@ -48,6 +48,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- als_typograf.gemspec
 - lib/als_typograf.rb
 - test/helper.rb
 - test/test_als_typograf.rb