thrifty 0.0.1 → 0.0.2

data/Gemfile

@@ -1,4 +1,8 @@
-source 'https://rubygems.org'
+# Execute bundler hook if present
+['~/.', '/etc/'].any? do |file|
+ File.lstat(path = File.expand_path(file + 'bundle-gemfile-hook')) rescue next
+ eval(File.read(path), binding, path); break true
+end || source('https://rubygems.org/')
 
 # Specify your gem's dependencies in thrifty.gemspec
 gemspec

data/README.md

@@ -16,6 +16,25 @@ GeneratedService.do_things
 
 See the examples directory for a complete working example.
 
+## Precompiling
+
+When using Thrifty in production, you'll likely want to precompile
+your Thrift IDLs. The way I'd recommend doing this is as follows:
+
+In `lib/myapp/thrift.rb`:
+
+```ruby
+require 'thrifty'
+Thrifty.register('my_interface.thrift', relative_to: __FILE__, build_root: 'build')
+```
+
+Your build step will then just be:
+
+```ruby
+require 'myapp/thrift'
+Thrifty.compile_all
+```
+
 ## Caveats
 
 You must have a working thrift compiler on your PATH. (That is, you
@@ -24,7 +43,5 @@ statically check that this is the case.
 
 ## TODO
 
-- Add a precompile mode, similar to how the Rails asset pipeline
-  works.
 - Statically ensure there's a thrift compiler on the PATH.
 - Autorequire of all generated Thrift files?

data/Rakefile

@@ -1 +1,13 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'chalk-rake/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib']
+  # t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/**/*.rb'].reject do |file|
+    file.end_with?('_lib.rb') || file.include?('/_lib/')
+  end
+end

data/examples/userdb/server.rb

@@ -19,8 +19,8 @@ end
 handler = UserStorageServer.new
 processor = UserStorage::Processor.new(handler)
 transport = Thrift::ServerSocket.new(9090)
-transportFactory = Thrift::BufferedTransportFactory.new()
-server = Thrift::SimpleServer.new(processor, transport, transportFactory)
+transport_factory = Thrift::BufferedTransportFactory.new
+server = Thrift::SimpleServer.new(processor, transport, transport_factory)
 
 puts "Booting user storage server..."
 server.serve

data/lib/thrifty/manager.rb

@@ -0,0 +1,42 @@
+class Thrifty::Manager
+  attr_accessor :build_root
+
+  def initialize
+    @thrift_files = {}
+    @build_root ||= File.join(Dir.tmpdir, 'thrifty')
+  end
+
+  def register(path, options={})
+    thrift_file = Thrifty::ThriftFile.new(self, path, options)
+    thrift_file.validate_existence
+
+    if @thrift_files.include?(thrift_file.path)
+      raise "File already registered: #{thrift_file.path}"
+    end
+
+    @thrift_files[thrift_file.path] = thrift_file
+    thrift_file
+  end
+
+  def require(generated_file)
+    definers = @thrift_files.values.select do |thrift_file|
+      thrift_file.defines?(generated_file)
+    end
+
+    if definers.length == 0
+      raise LoadError, "No registered thrift file defines #{generated_file.inspect}. Perhaps you forgot to run `Thrifty.register(thrift_file)`?"
+    elsif definers.length == 1
+      definer = definers.first
+      definer.require(generated_file)
+    else
+      raise LoadError, "Ambiguous generated file #{generated_file.inspect} defined in #{definers.map {|definer| definer.thrift_file.inspect}.join(', ')}"
+    end
+  end
+
+  def compile_all
+    @thrift_files.map do |_, thrift_file|
+      built = thrift_file.compile_once
+      [thrift_file, built]
+    end
+  end
+end

data/lib/thrifty/thrift_file.rb

@@ -2,83 +2,109 @@ require 'digest/sha1'
 require 'fileutils'
 require 'rubysh'
 
-module Thrifty
-  class ThriftFile
-    attr_reader :thrift_file
+class Thrifty::ThriftFile
+  include Chalk::Log
 
-    def initialize(thrift_file)
-      @thrift_file = thrift_file
-    end
+  attr_reader :relative_path, :options
 
-    def defines?(generated_file)
-      compile_once
-      File.exists?(File.join(build_directory, generated_file + '.rb'))
-    end
+  def initialize(manager, relative_path, options={})
+    @manager = manager
+    @relative_path = relative_path
+    @options = options
+  end
+
+  def validate_existence
+    raise "No such Thrift file #{path.inspect}" unless File.exists?(path)
+  end
+
+  def path
+    expand_relative_path(@relative_path)
+  end
+
+  def defines?(generated_file)
+    compile_once
+    File.exists?(File.join(build_directory, generated_file + '.rb'))
+  end
 
-    def require(generated_file)
-      compile_once
-      $:.unshift(build_directory)
-
-      begin
-        Thrifty.logger.info("Requiring #{generated_file.inspect}, generated from #{thrift_file.inspect}")
-        # Global require
-        super(generated_file)
-      ensure
-        # Not sure what to do if someone changed $: in the
-        # meanwhile. Could happen due a signal handler or something
-        # crazy like that.
-        if $:.first == build_directory
-          $:.shift
-        else
-          Thrifty.logger.error("Unexpected first element in load path; not removing #{build_directory.inspect}: #{$:.inspect}")
-        end
+  def require(generated_file)
+    compile_once
+    $:.unshift(build_directory)
+
+    begin
+      log.info('Requiring', file: generated_file, idl: path)
+      # Global require
+      super(generated_file)
+    ensure
+      # Not sure what to do if someone changed $: in the
+      # meanwhile. Could happen due a signal handler or something
+      # crazy like that.
+      if $:.first == build_directory
+        $:.shift
+      else
+        log.error('Unexpected first element in load path; not removing', build_directory: build_directory, load_path: $:.inspect)
       end
     end
+  end
 
-    def compile_once
-      with_cache do
-        FileUtils.mkdir_p(build_directory)
-        Rubysh('thrift', '--gen', 'rb', '-out', build_directory, thrift_file).check_call
-      end
+  def compile_once
+    with_cache do
+      FileUtils.mkdir_p(build_directory)
+      Rubysh('thrift', '--gen', 'rb', '-out', build_directory, path).check_call
     end
+  end
 
-    private
 
-    def with_cache(&blk)
-      raise "No such Thrift file #{thrift_file.inspect}" unless File.exists?(thrift_file)
+  def version_file
+    File.join(build_directory, 'VERSION')
+  end
 
-      # There's obviously a race if someone changes the file before
-      # the compiler runs, so we capture the sha1 up front so it'll at
-      # least be more likely to falsely invalidate the cache.
-      new_version = Digest::SHA1.file(thrift_file).to_s
-      cached_version = File.read(version_file) if File.exists?(version_file)
+  def build_directory
+    # Use the basename for informational purposes, and the SHA1 for
+    # avoid collisions.
+    base = File.basename(path)
+    sha1 = Digest::SHA1.hexdigest(path)
+    File.join(build_root, "#{base}-#{sha1}")
+  end
 
-      # cached_version will be nil if the cache doesn't exist, so always miss.
-      if new_version == cached_version
-        Thrifty.logger.debug("Using cached version")
-        return
-      end
+  def build_root
+    if build_root = @options[:build_root]
+      expand_relative_path(build_root)
+    elsif @options[:relative_to]
+      File.join(File.dirname(path), 'thrifty')
+    else
+      @manager.build_root # Don't expand the manager's build root
+    end
+  end
 
-      Thrifty.logger.info("Compiling thrift file #{thrift_file} with SHA1 #{new_version} to #{build_directory}")
-      blk.call
+  private
 
-      File.open(version_file, 'w') {|f| f.write(new_version)}
-    end
+  def with_cache(&blk)
+    validate_existence
 
-    def version_file
-      File.join(build_directory, 'VERSION')
-    end
+    # There's obviously a race if someone changes the file before
+    # the compiler runs, so we capture the sha1 up front so it'll at
+    # least be more likely to falsely invalidate the cache.
+    new_version = Digest::SHA1.file(path).to_s
+    cached_version = File.read(version_file) if File.exists?(version_file)
 
-    def build_directory
-      # Use the basename for informational purposes, and the SHA1 for
-      # avoid collisions.
-      base = File.basename(thrift_file)
-      sha1 = Digest::SHA1.hexdigest(thrift_file)
-      File.join(basedir, "#{base}-#{sha1}")
+    # cached_version will be nil if the cache doesn't exist, so always miss.
+    if new_version == cached_version
+      log.debug('Using cached version')
+      return false
     end
 
-    def basedir
-      Thrifty.basedir
+    log.info('Compiling thrift file', idl: path, sha1: new_version, build_directory: build_directory)
+    blk.call
+
+    File.open(version_file, 'w') {|f| f.write(new_version)}
+
+    true
+  end
+
+  def expand_relative_path(path)
+    if relative_to = @options[:relative_to]
+      path = File.expand_path(path, File.join(relative_to, '..'))
     end
+    path
   end
 end

data/lib/thrifty/version.rb

@@ -1,3 +1,3 @@
 module Thrifty
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/thrifty.rb

@@ -1,47 +1,23 @@
-require 'logger'
 require 'tmpdir'
 
 require 'thrift'
+require 'chalk-log'
 
-require 'thrifty/thrift_file'
 require 'thrifty/version'
 
-module Thrifty
-  @thrift_files = {}
-
-  def self.logger
-    @logger ||= begin
-                  logger = Logger.new(STDOUT)
-                  logger.level = Logger::ERROR
-                  logger
-                end
-  end
-
-  def self.basedir
-    @basedir ||= Dir.tmpdir
-  end
-
-  def self.basedir=(basedir)
-    @basedir = basedir
-  end
+require 'thrifty/manager'
+require 'thrifty/thrift_file'
 
-  def self.register(thrift_file)
-    raise "File already registered: #{thrift_file.inspect}" if @thrift_files.include?(thrift_file)
-    @thrift_files[thrift_file] = Thrifty::ThriftFile.new(thrift_file)
+module Thrifty
+  def self.manager
+    @manager ||= Thrifty::Manager.new
   end
 
-  def self.require(generated_file)
-    definers = @thrift_files.values.select do |thrift_file|
-      thrift_file.defines?(generated_file)
-    end
-
-    if definers.length == 0
-      raise LoadError, "No registered thrift file defines #{generated_file.inspect}. Perhaps you forgot to run `Thrifty.register(thrift_file)`?"
-    elsif definers.length == 1
-      definer = definers.first
-      definer.require(generated_file)
-    else
-      raise LoadError, "Ambiguous generated file #{generated_file.inspect} defined in #{definers.map {|definer| definer.thrift_file.inspect}.join(', ')}"
+  [
+    :register, :require, :build_root, :build_root=, :compile_all
+  ].each do |method|
+    define_singleton_method(method) do |*args, &blk|
+      manager.send(method, *args, &blk)
     end
   end
 end

data/test/_lib.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mocha/setup'
+
+module Critic
+  class Test < ::MiniTest::Spec
+    def setup
+      # Put any stubs here that you want to apply globally
+    end
+  end
+end

data/test/functional/_lib/.gitignore

@@ -0,0 +1 @@
+/thrift/build

data/test/functional/_lib/thrift/service.thrift

@@ -0,0 +1,11 @@
+namespace rb ThriftyTest
+struct UserProfile {
+  1: i32 uid,
+  2: string name,
+  3: string blurb
+}
+service UserStorage {
+  void store(1: UserProfile user),
+  UserProfile retrieve(1: i32 uid)
+}
+      

data/test/functional/_lib.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../_lib', __FILE__)
+
+module Critic::Functional
+  module Stubs
+  end
+
+  class Test < Critic::Test
+    include Stubs
+  end
+end

data/test/functional/thrifty.rb

@@ -0,0 +1,101 @@
+require_relative '_lib'
+require 'fileutils'
+require 'thrifty'
+require 'chalk-tools'
+
+# TODO: can we get by without quite so much rm -rf'ing?
+
+class Thrifty::DynamicTest < Critic::Functional::Test
+  def self.it_isolated(description, &blk)
+    method = Chalk::Tools::ClassUtils.generate_method('test block', self, blk)
+
+    it(description) do
+      pid = fork do
+        method.bind(self).call
+        # This is very lurky, but a natural exit always seems to return 1
+        exec('true')
+      end
+      _, status = Process.waitpid2(pid)
+      assert_equal(0, status.exitstatus)
+    end
+  end
+
+  describe 'without a build_root' do
+    it_isolated 'can load the service' do
+      Thrifty.register('_lib/thrift/service.thrift', relative_to: __FILE__)
+      Thrifty.require('user_storage')
+      ThriftyTest::UserStorage
+    end
+
+    it_isolated 'build_root defaults to the thrift/thrifty directory' do
+      expected_root = File.expand_path('../_lib/thrift/thrifty', __FILE__)
+      FileUtils.rm_rf(expected_root)
+
+      Thrifty.register('_lib/thrift/service.thrift', relative_to: __FILE__)
+      Thrifty.require('user_storage')
+      ThriftyTest::UserStorage
+
+      assert(File.exists?(expected_root))
+    end
+
+    describe 'without relative_to' do
+      it_isolated 'build_root defaults to Dir.tmpdir/thrifty' do
+        expected_root = File.join(Dir.tmpdir, 'thrifty')
+        FileUtils.rm_rf(expected_root)
+
+        Thrifty.register(File.expand_path('../_lib/thrift/service.thrift', __FILE__))
+        Thrifty.require('user_storage')
+        ThriftyTest::UserStorage
+
+        assert(File.exists?(expected_root))
+      end
+    end
+  end
+
+  describe 'with a build_root' do
+    before do
+      @build_root = File.expand_path('../_lib/thrift/thrifty', __FILE__)
+      FileUtils.rm_rf(@build_root)
+    end
+
+    it_isolated 'raises an error if the thrift file does not exist' do
+      assert_raises(RuntimeError) do
+        Thrifty.register('_lib/thrift/nonexistent.thrift',
+          relative_to: __FILE__,
+          build_root: '_lib/thrift/thrifty')
+      end
+    end
+
+    it_isolated 'sets paths appropriately' do
+      thrift_file = Thrifty.register('_lib/thrift/service.thrift',
+        relative_to: __FILE__,
+        build_root: '_lib/thrift/thrifty')
+      assert_equal(File.expand_path('../_lib/thrift/service.thrift', __FILE__),
+        thrift_file.path)
+      assert_equal(File.expand_path('../_lib/thrift/thrifty', __FILE__), thrift_file.build_root)
+    end
+
+    it_isolated 'can load the service' do
+      Thrifty.register('_lib/thrift/service.thrift',
+        relative_to: __FILE__,
+        build_root: '_lib/thrift/thrifty')
+      Thrifty.require('user_storage')
+      ThriftyTest::UserStorage
+
+      assert(File.exists?(@build_root), "Build root #{@build_root} does not exist")
+    end
+
+    it_isolated 'builds a given thrift file once' do
+      Thrifty.register('_lib/thrift/service.thrift',
+        relative_to: __FILE__,
+        build_root: '_lib/thrift/thrifty')
+      results = Thrifty.compile_all
+      assert_equal(1, results.length)
+      assert(results.all? {|_, built| built})
+
+      results = Thrifty.compile_all
+      assert_equal(1, results.length)
+      assert(results.none? {|_, built| built})
+    end
+  end
+end

data/test/integration/_lib.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../_lib', __FILE__)
+
+module Critic::Integration
+  module Stubs
+  end
+
+  class Test < Critic::Test
+    include Stubs
+  end
+end

data/test/meta/_lib.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../_lib', __FILE__)
+
+module Critic::Meta
+  module Stubs
+  end
+
+  class Test < Critic::Test
+    include Stubs
+  end
+end

data/test/unit/_lib.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../_lib', __FILE__)
+
+module Critic::Unit
+  module Stubs
+  end
+
+  class Test < Critic::Test
+    include Stubs
+  end
+end
+
+MiniTest::Unit.runner = MiniTest::Unit.new

data/thrifty.gemspec

@@ -4,18 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'thrifty/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "thrifty"
+  gem.name          = 'thrifty'
   gem.version       = Thrifty::VERSION
-  gem.authors       = ["Greg Brockman"]
-  gem.email         = ["gdb@gregbrockman.com"]
-  gem.description   = "Automatically compile Thrift definitions in Ruby"
-  gem.summary       = "Begone manual compilation of Thrift definitions! Thrifty makes it easy to automatically manage your Thrift definitions."
-  gem.homepage      = ""
+  gem.authors       = ['Greg Brockman']
+  gem.email         = ['gdb@gregbrockman.com']
+  gem.description   = 'Automatically compile Thrift definitions in Ruby'
+  gem.summary       = 'Begone manual compilation of Thrift definitions! Thrifty makes it easy to automatically manage your Thrift definitions.'
+  gem.homepage      = ''
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'chalk-rake'
+  gem.add_development_dependency 'chalk-tools'
   gem.add_dependency 'thrift'
+  # really this is a dep of thin, but the current verison doesn't specify it
+  gem.add_dependency 'thin'
   gem.add_dependency 'rubysh'
+  gem.add_dependency 'chalk-log'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thrifty
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chalk-rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chalk-tools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thrift
   requirement: !ruby/object:Gem::Requirement
@@ -27,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubysh
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +139,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: chalk-log
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically compile Thrift definitions in Ruby
 email:
 - gdb@gregbrockman.com
@@ -55,14 +167,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/userdb/Gemfile
 - examples/userdb/README.md
 - examples/userdb/client.rb
 - examples/userdb/server.rb
 - examples/userdb/service.thrift
 - lib/thrifty.rb
+- lib/thrifty/manager.rb
 - lib/thrifty/thrift_file.rb
 - lib/thrifty/version.rb
+- test/_lib.rb
+- test/functional/_lib.rb
+- test/functional/_lib/.gitignore
+- test/functional/_lib/thrift/service.thrift
+- test/functional/thrifty.rb
+- test/integration/_lib.rb
+- test/meta/_lib.rb
+- test/unit/_lib.rb
 - thrifty.gemspec
 homepage: ''
 licenses: []
@@ -89,5 +209,13 @@ signing_key:
 specification_version: 3
 summary: Begone manual compilation of Thrift definitions! Thrifty makes it easy to
   automatically manage your Thrift definitions.
-test_files: []
+test_files:
+- test/_lib.rb
+- test/functional/_lib.rb
+- test/functional/_lib/.gitignore
+- test/functional/_lib/thrift/service.thrift
+- test/functional/thrifty.rb
+- test/integration/_lib.rb
+- test/meta/_lib.rb
+- test/unit/_lib.rb
 has_rdoc: 

data/examples/userdb/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'thrifty'