webify_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e1ac9a0368f62f2da77e358e8d3408f55edd0f1
+  data.tar.gz: 93e629bea658ff3106955d14a6d964f24de191ee
+SHA512:
+  metadata.gz: 0d6205202ec1e13660097aa0702d0c62b73ca5fa7be06937802fab7d8180202965ede42d81328ff294f4479d51dd9a06aed0406939f3a939c5b7fac687bbc4a2
+  data.tar.gz: 8e985e2b6699c961fbc011878d1f07a492b86a5603e493cc3ede1d62b565775b4f7abf3b0436b48ed2c28e16de4b515bb90b9a506b649c20032d4af193166ed3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 David Natsvlishvili
+
+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,160 @@
+= WebifyRuby - Haskell Webify bindings gem for Ruby and Rails Applications
+
+ Version 0.0.1 :: Lazi
+
+== Usage
+
+==== Option #1: Install executables depending on your system
+
+You can find compiled executables for Linux 32, Linux 64, Mac OS X 64, Win 32 here
+  
+https://github.com/dachi-gh/webify/tree/executables
+
+==== Option #2: Compile Haskell application for your desired OS from here
+
+https://github.com/dachi-gh/webify
+
+==== Add to your Gemfile
+ gem 'webify_ruby', :git => 'git://github.com/dachi-gh/webify_ruby.git'
+
+You can require a library to use in your Ruby application
+  require 'webify_ruby'
+
+You don't have to do so if you're using rails as bundler can do it for you
+  Bundler.require(:default, Rails.env)
+
+==== Make a Rake task for a quick example
+
+  namespace :webify_ruby do
+    desc 'Convert a file and distribute'
+    task :convert, [:source, :dir_fonts, :dir_css] => :environment do |t, args|
+      pp WebifyRuby::Convert.new(
+        args.source,
+        dir: args.dir_fonts,
+        css: args.dir_css
+      )
+    end
+  end
+
+and run it as
+ $ rake webify_ruby:convert['my_fonts/sample.ttf','demo/convert','demo/css']
+
+If successful you should get find converted files under created directory demo/convert and stylesheet css file with relative links under demo/css directory
+
+== Explore
+
+==== Convert and place in the same directory
+Convert constructor requires one parameter at least, which is a ttf or otf file
+ WebifyRuby::Convert.new('fonts/font.ttf')
+
+This should normally generate svg, woff and eot and place all four fonts in the same directory without css
+
+==== Convert and place in desired directory
+
+Constructor can take a directory parameter
+  WebifyRuby::Convert.new('fonts/font.ttf', dir: 'webfonts')
+
+This example creates webfonts directory if necessary and puts four webfont files there
+
+==== Generate stylesheets along the fonts
+
+It is possible to pass a parameter to the class constructor, so it knows you want stylesheets too
+  WebifyRuby::Convert.new('fonts/my_font.ttf, css: 'stylesheets/fonts')
+
+Would create a stylesheets directory if necessary and place my_font.css with relative urls
+
+==== Generate stylesheet with custom urls
+
+There might be cases when you're working with subdomains for example and relative urls are not for you
+  WebifyRuby::Convert.new('fonts/my_font.ttf, css: 'stylesheets/custom', link_to: 'http://fonts.example.com')
+
+Writes a my_font.css file under stylesheets/custom directory with custom url prepended to filename, like this:
+
+  @font-face {
+  font-family: 'my_font';
+  src: url('http://fonts.example.com/my_font.eot'); 
+  src: url('http://fonts.example.com/my_font.eot?#iefix') format('embedded-opentype'),
+       url('http://fonts.example.com/my_font.svg#my_font') format('svg'),
+       url('http://fonts.example.com/my_font.woff') format('woff');
+  font-weight: normal;
+  font-style: normal;
+  }
+
+==== Get stylesheet without creating files
+
+You might need a css styles to write to a file by yourself, in this case you need to look for returned values
+  convert = WebifyRuby::Convert.new('fonts/my_font.ttf, css: true, link_to: 'http://example.com/fonts')
+  puts convert.styles
+
+would result in
+
+  > puts convert.styles
+  @font-face {
+  font-family: 'my_font';
+  src: url('http://fonts.example.com/my_font.eot'); 
+  src: url('http://fonts.example.com/my_font.eot?#iefix') format('embedded-opentype'),
+       url('http://fonts.example.com/my_font.svg#my_font') format('svg'),
+       url('http://fonts.example.com/my_font.woff') format('woff');
+  font-weight: normal;
+  font-style: normal;
+  }
+  => nil 
+
+So you can make use of generated styles according to your needs
+
+==== Values that you get after converting
+
+You might need to know about directory names or other information that library operates on. After initializing a Convert class, you get an object that should have everything you need. An example is here
+
+  2.1.0-preview1 :028 > convert = WebifyRuby::Convert.new('public/fonts/my_font.ttf',
+  dir:'my_dir_fonts',
+  css: 'my_dir_css',
+  link_to: 'http://example.com/my_dir_fonts')
+   => #<WebifyRuby::Convert:0x007fbc1af6fd00
+      @desired_dir="my_dir_fonts",
+      @css="my_dir_css",
+      @link_to="http://example.com/my_dir_fonts",
+      @original_file="public/fonts/my_font.ttf",
+      @original_dir="public/fonts",
+      @result_dir="my_dir_fonts/d20140211-56782-4cglvv",
+      @file="my_dir_fonts/d20140211-56782-4cglvv/my_font.ttf",
+      @command="webify my_dir_fonts/d20140211-56782-4cglvv/my_font.ttf",
+      @output="Generating my_dir_fonts/d20140211-56782-4cglvv/my_font.eot
+      Generating my_dir_fonts/d20140211-56782-4cglvv/my_font.woff
+      Generating my_dir_fonts/d20140211-56782-4cglvv/my_font.svg
+      Available cmaps
+      -----------------------------------------------------------------------------
+      PlatformId | EncodingId | Description                                        
+      0          | 3          | Unicode 2.0 and onwards semantics, Unicode BMP only
+      1          | 0          | Macintosh Roman 8-bit simple                       
+                 | 1          | Microsoft Unicode BMP (UCS-2)
+      -----------------------------------------------------------------------------
+      Selecting platformId 3 encodingId 1 -- Microsoft Unicode BMP (UCS-2)",
+      @generated=["my_dir_fonts/d20140211-56782-4cglvv/my_font.eot",
+      "my_dir_fonts/d20140211-56782-4cglvv/my_font.woff",
+      "my_dir_fonts/d20140211-56782-4cglvv/my_font.svg"],
+      @styles="@font-face {
+      font-family: 'my_font';
+      src: url('http://example.com/my_dir_fonts/my_font.eot');
+      src: url('http://example.com/my_dir_fonts/my_font.eot?#iefix') format('embedded-opentype'),
+           url('http://example.com/my_dir_fonts/my_font.svg#my_font') format('svg'),
+           url('http://example.com/my_dir_fonts/my_font.woff') format('woff');
+           font-weight: normal;\nfont-style: normal;
+      }">
+
+That way you can for example know a generated directory path by running
+  convert.result_dir
+
+
+== Gem Author
+
+Dachi Natsvlishvili mailto:dnatsvlishvili@gmail.com
+
+== Todo
+
+1. Add support for kerning option
+2. Add support for desired output files
+
+== Licence
+
+https://github.com/dachi-gh/webify_ruby/blob/master/MIT-LICENSE

data/Rakefile

@@ -0,0 +1,30 @@
+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    = 'WebifyRuby'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'webify_ruby/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/lib/tasks/version.rake

@@ -0,0 +1,8 @@
+require 'webify_ruby/version'
+
+namespace :webify_ruby do
+  desc 'Shows a WebifyRuby gem version'
+  task :version do
+    puts "You are running WebifyRuby v.#{WebifyRuby::VERSION} so far."
+  end
+end

data/lib/webify_ruby/convert.rb

@@ -0,0 +1,99 @@
+require 'fileutils'
+require 'open3'
+require 'tmpdir'
+require 'shellwords'
+
+module WebifyRuby
+  class Convert
+    attr_reader :file, :original_file, :command, :output, :generated, :original_dir, :result_dir, :desired_dir, :css, :link_to, :styles
+
+    def initialize(file, dir: nil, css: nil, link_to: nil)
+      [file, dir]
+
+      @desired_dir = dir
+      @css = css
+      @link_to = link_to
+
+      raise Errno::ENOENT, "The font file '#{file}' does not exist" unless File.exists?(file)
+      @original_file = file
+
+      raise Error, "The font file '#{file}' is not valid" unless WebifyRuby::EXT.include? File.extname(@original_file)
+
+      @original_dir = File.dirname(@original_file)
+      raise Errno::ENOENT, "Can't find directory '#{@original_dir}'" unless File.directory? @original_dir
+
+      @result_dir = Dir.mktmpdir(nil, destination_dir)
+
+      FileUtils.cp(@original_file, @result_dir)
+
+      @file = File.join(@result_dir, File.basename(@original_file))
+
+      process
+
+      if affected_files.to_a.length == 0
+        WebifyRuby.logger.info "Host did not create any files\n@command\n#{@command}\n@output\n#{@output}\n"
+      end
+
+      generate_css unless @css.nil?
+    end
+
+    def affected_files
+      Dir[@result_dir + '/*.{ttf,eot,woff,svg}'].reject { |f| f[@file] }
+    end
+
+    def is_valid?
+      false if not @output.include? 'Generating' or @output.include? 'Failed'
+      true
+    end
+
+    def generate_css
+      needs = affected_files.map { |m| File.extname(m)[1..-1].to_sym }
+
+      if should_write_css?
+        WebifyRuby::Css.relative_from = @link_to ? nil : @css
+        WebifyRuby::Css.link_to = @link_to
+      end
+
+      css = WebifyRuby::Css.new(File.basename(@file, ".*"), @file, *needs)
+      @styles = css.result
+
+      css.write @css if should_write_css?
+    end
+
+    protected
+
+    def should_write_css?
+      @css.respond_to?(:to_str) and not @css.to_s.empty?
+    end
+
+    private
+
+    def destination_dir
+      if @desired_dir.nil?
+        @original_dir
+      else
+        if not File.directory?(@desired_dir)
+          FileUtils.mkdir_p(@desired_dir)
+        else
+          @desired_dir
+        end
+      end
+    end
+
+    def process
+      @command = "#{WebifyRuby.webify_binary} #{Shellwords.escape(@file)}"
+      @output = Open3.popen3(@command) { |stdin, stdout, stderr| stdout.read }
+
+      if not is_valid?
+        WebifyRuby.logger.fatal "Invalid input received\n@command\n#{@command}\n@output\n#{@output}\n"
+        raise Error, "Binary responded with failure:\n#{@output}"
+      end
+
+      @generated = Shellwords.escape(@output).split("'\n'").select{|s| s.match('Generating')}.join().split('Generating\\ ')[1..-1]
+
+      if @generated.to_a.empty?
+        WebifyRuby.logger.info "No file output received\n@command\n#{@command}\n@output\n#{@output}\n"
+      end
+    end
+  end
+end

data/lib/webify_ruby/css.rb

@@ -0,0 +1,60 @@
+require 'erb'
+require 'fileutils'
+require 'pathname'
+
+module WebifyRuby
+  TEMPLATE = <<-CSS.gsub /^\s*/, ''
+  @font-face {
+    font-family: '<%= @name %>';
+    <% if has_eot %>src: url('<%= @url %>.eot'); <% end %>
+    <% if has_eot %>src: url('<%= @url %>.eot?#iefix') format('embedded-opentype')<%if has_ttf or has_woff or has_svg %>,<%end%><%else%>src:<% end %>
+        <% if has_svg %>     url('<%= @url %>.svg#<%= @name %>') format('svg')<%if has_ttf or has_woff %>,<%end%><% end %>
+        <% if has_woff %>     url('<%= @url %>.woff') format('woff')<%if has_ttf%>,<%end%><% end %>
+        <% if has_ttf %>     url('<%= @url %>.ttf') format('truetype')<% end %>;
+    font-weight: normal;
+    font-style: normal;
+  }
+  CSS
+
+  class Css
+    attr_reader :result, :filename, :url, :dir, :css_file, :output
+
+    %w(eot svg woff ttf).each do |ext|
+      define_method('has_' + ext) { @has.include? ext.to_sym }
+    end
+
+    class << self;attr_accessor :relative_from, :link_to;end
+
+    def initialize(name, file, *has)
+      [name, file, has]
+
+      @has = has
+      @name = name
+
+      @filename = File.basename(file, '.*')
+
+      @url = (self.class.relative_from.nil? ?
+          (self.class.link_to ? (self.class.link_to + '/' + File.basename(file)) : file)
+      : Pathname.new(file).relative_path_from(Pathname.new(self.class.relative_from))).to_s[/.*(?=\..+$)/]
+
+      make_css
+    end
+
+    def write(dir)
+      @dir = FileUtils.mkdir_p dir
+      @css_file = File.join(@dir, @filename + '.css')
+
+      File.delete(@css_file) if File.exist?(@css_file)
+      @output = File.open(@css_file, 'w') { |file| file.write(@result) }
+    end
+
+    private
+
+    def make_css
+      template = ERB.new TEMPLATE
+      result = template.result binding
+      (0..3).each { result.gsub!(/\n;\n/m, ";\n") }
+      @result = result.gsub /^$\n/, ''
+    end
+  end
+end

data/lib/webify_ruby/errors.rb

@@ -0,0 +1,3 @@
+module WebifyRuby
+  class Error < StandardError;end
+end

data/lib/webify_ruby/railtie.rb

@@ -0,0 +1,5 @@
+module WebifyRuby
+  class Railtie < Rails::Railtie
+    rake_tasks { WebifyRuby::load_tasks }
+  end
+end

data/lib/webify_ruby/tasks.rb

@@ -0,0 +1,7 @@
+module WebifyRuby
+  def self.load_tasks
+    Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f; }
+  end
+
+  self.load_tasks unless defined?(Rails)
+end

data/lib/webify_ruby/version.rb

@@ -0,0 +1,3 @@
+module WebifyRuby
+  VERSION = "0.0.1"
+end

data/lib/webify_ruby.rb

@@ -0,0 +1,34 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'logger'
+
+require 'webify_ruby/version'
+require 'webify_ruby/errors'
+require 'webify_ruby/convert'
+require 'webify_ruby/css'
+require 'webify_ruby/tasks'
+require 'webify_ruby/railtie' if defined?(Rails)
+
+module WebifyRuby
+
+  EXT = %w(.ttf .otf)
+
+  def self.logger=(log)
+    @logger = log
+  end
+
+  def self.logger
+    return @logger if @logger
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::INFO
+    @logger = logger
+  end
+
+  def self.webify_binary=(bin)
+    @webify_binary = bin
+  end
+
+  def self.webify_binary
+    @webify_binary || 'webify'
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: webify_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dachi Natsvlishvili
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: WebifyRuby communicates with Webify and provides nice and easy working
+  interface
+email:
+- dnatsvlishvili@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/tasks/version.rake
+- lib/webify_ruby.rb
+- lib/webify_ruby/convert.rb
+- lib/webify_ruby/css.rb
+- lib/webify_ruby/errors.rb
+- lib/webify_ruby/railtie.rb
+- lib/webify_ruby/tasks.rb
+- lib/webify_ruby/version.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log
+homepage: https://github.com/dachi-gh/webify_ruby
+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: A Ruby wrapper for Webify application written in Haskell
+test_files:
+- test/dummy/db/test.sqlite3
+- test/dummy/log/test.log