thrifty 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Greg Brockman
+
+MIT License
+
+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.md

@@ -0,0 +1,30 @@
+# Thrifty
+
+Tired of manually regenerating your Thrift interface code every time
+the definition changes? Thrifty manages your Thrift interface
+definitions behind the scenes.
+
+## Usage
+
+```ruby
+require 'thrifty'
+Thrifty.register('my_interface.thrift')
+
+Thrifty.require('generated_service')
+GeneratedService.do_things
+```
+
+See the examples directory for a complete working example.
+
+## Caveats
+
+You must have a working thrift compiler on your PATH. (That is, you
+should be able to just type 'thrift'.) Thrifty does not currently
+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

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/userdb/Gemfile

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

data/examples/userdb/README.md

@@ -0,0 +1,15 @@
+Simple client/server example from using the Thrift definition file
+from http://thrift.apache.org/.
+
+To test it out, do the following:
+
+- Run 'bundle'
+- Run 'bundle exec ruby server.rb' in one terminal. Leave it running.
+- Run 'bundle exec ruby client.rb' in another terminal.
+
+You should see something like the following from the client:
+
+```
+Storing <UserProfile uid:1234, name:"my name!", blurb:"your name!">
+Retrieved <UserProfile uid:1234, name:"my name!", blurb:"your name!">
+```

data/examples/userdb/client.rb

@@ -0,0 +1,22 @@
+require 'thrifty'
+Thrifty.register('service.thrift')
+Thrifty.require('user_storage')
+
+port = ARGV[0] || 9090
+
+transport = Thrift::BufferedTransport.new(Thrift::Socket.new('127.0.0.1', 9090))
+protocol = Thrift::BinaryProtocol.new(transport)
+client = UserStorage::Client.new(protocol)
+
+transport.open
+
+profile = UserProfile.new
+profile.uid = 1234
+profile.name = 'my name!'
+profile.blurb = 'your name!'
+
+puts "Storing #{profile.inspect}"
+client.store(profile)
+
+retrieved = client.retrieve(1234)
+puts "Retrieved #{retrieved.inspect}"

data/examples/userdb/server.rb

@@ -0,0 +1,26 @@
+require 'thrifty'
+Thrifty.register('service.thrift')
+Thrifty.require('user_storage')
+
+class UserStorageServer
+  def initialize
+    @store = {}
+  end
+
+  def store(user_profile)
+    @store[user_profile.uid] = user_profile
+  end
+
+  def retrieve(uid)
+    @store[uid]
+  end
+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)
+
+puts "Booting user storage server..."
+server.serve

data/examples/userdb/service.thrift

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

data/lib/thrifty/thrift_file.rb

@@ -0,0 +1,84 @@
+require 'digest/sha1'
+require 'fileutils'
+require 'rubysh'
+
+module Thrifty
+  class ThriftFile
+    attr_reader :thrift_file
+
+    def initialize(thrift_file)
+      @thrift_file = thrift_file
+    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
+      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
+    end
+
+    private
+
+    def with_cache(&blk)
+      raise "No such Thrift file #{thrift_file.inspect}" unless File.exists?(thrift_file)
+
+      # 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)
+
+      # 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
+
+      Thrifty.logger.info("Compiling thrift file #{thrift_file} with SHA1 #{new_version} to #{build_directory}")
+      blk.call
+
+      File.open(version_file, 'w') {|f| f.write(new_version)}
+    end
+
+    def version_file
+      File.join(build_directory, 'VERSION')
+    end
+
+    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}")
+    end
+
+    def basedir
+      Thrifty.basedir
+    end
+  end
+end

data/lib/thrifty/version.rb

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

data/lib/thrifty.rb

@@ -0,0 +1,47 @@
+require 'logger'
+require 'tmpdir'
+
+require 'thrift'
+
+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
+
+  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)
+  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(', ')}"
+    end
+  end
+end

data/thrifty.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thrifty/version'
+
+Gem::Specification.new do |gem|
+  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.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.add_dependency 'thrift'
+  gem.add_dependency 'rubysh'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: thrifty
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Greg Brockman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thrift
+  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
+    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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- 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/thrift_file.rb
+- lib/thrifty/version.rb
+- thrifty.gemspec
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Begone manual compilation of Thrift definitions! Thrifty makes it easy to
+  automatically manage your Thrift definitions.
+test_files: []
+has_rdoc: