sails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f659284fee2c294ceb15bf368ea80f61c8331fc3
-  data.tar.gz: 0f52d780eb04bafa7b4a63ef9d5460fce2ea8c2a
+  metadata.gz: 9910e5d27ef628ca22aec968edd2ed2a94604295
+  data.tar.gz: 6e72d2491ad1950a6a2e6946205a6ac84e266914
 SHA512:
-  metadata.gz: 717ac7ec1138af2afe82d8460af64c0e5cafe6573fbe8e1b198124823074eaceba4514a93e9ca1da316c22b4eb9ec621468c53914f6721df3b583d664973619d
-  data.tar.gz: 3aa695a566367311681b0439a7e16c48171c2595b228b3775411139cd6583f88f08518a1319e39f4dc77121e4234ba42c024d29a7188616d76cf39e5b05d42ba
+  metadata.gz: 91c9dc674800da1fcb081bafa44438b5a673f68300df5ddbfdbc207b1c216de6354972a9dcb9866db5af245bf18dbb2d51b983b85c9c89c53e52768116561840
+  data.tar.gz: df6d3b9110cf3d8c3c71e31ae5c0f0c9e0744b2cd6826dd98517356b0e8b2835637f5565904e186e292aa118d33d8df7d59a7326280ec5ad1e7ee44688cd9c7e

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.1.4
+
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.1.1
+
+- Add `sails s`, `sails c` commands.
+- Refactor service layer, use class to instead module.
+- Support to custom Thrift protocol with `config.protocol = :binary`.
+- Fix ThriftServer::OperationFailed not found error.
+- Implement Master Process to manage and protect Child Process, keep it running/restart/stop, like Unicorn.
+- Add Sails.reload! to reload cache classes.
+- Sails console start with IRB class, and support `reload!`,`service` methods in console.
+
+## 0.1.0 / 2014-12-9
+
+- First version release.

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+gem 'dalli'
 gem 'rspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sails (0.1.0)
+    sails (0.1.1)
       activesupport (>= 3.2.0)
       thor
       thrift (>= 0.9.0)
@@ -15,6 +15,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    dalli (2.7.1)
     diff-lcs (1.2.5)
     i18n (0.6.11)
     json (1.8.1)
@@ -41,5 +42,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  dalli
   rspec
   sails!

data/README.md

@@ -3,17 +3,34 @@ Sails
 
 Sails, create [Thrift](thrift.apache.org) app server like Rails.
 
+[![Build Status](https://travis-ci.org/huacnlee/sails.svg)](https://travis-ci.org/huacnlee/sails) [![Gem Version](https://badge.fury.io/rb/sails.svg)](http://badge.fury.io/rb/sails)
+
+## Features
+
+- Rails style Thrift server;
+- Nonblocking mode;
+- I18n support;
+
 ## Installation
 
-```
+```bash
 $ gem install sails
+$ sails -h
+ENV: development
+Commands:
+  sails help [COMMAND]  # Describe available commands or one specific command
+  sails new APP_NAME    # Create a project
+  sails restart         # Restart Thrift server
+  sails start           # Start Thrift server
+  sails stop            # Stop Thrift server
+  sails version         # Show Sails version
 ```
 
 ## Usage
 
 ### Create new project
 
-```
+```bash
 $ sails new foo
 $ cd foo
 $ sails start
@@ -27,7 +44,36 @@ You can edit Thrift IDL in `app_name.thrift`, and then generate it to ruby sourc
 $ rake gen
 ```
 
+## Client Connect
+
+```ruby
+require "app/services/gen-rb/you_app_name"
+@transport ||= Thrift::FramedTransport.new(::Thrift::Socket.new('127.0.0.1', 4000, 10))
+@protocol  ||= Thrift::BinaryProtocol.new(@transport)
+@client    ||= Thrift::YouAppName::Client.new(@protocol)
+@transport.open()
+puts @client.ping()
+=> Ping pong
+```
+
+## Deploy
+
+```
+$ sails s --daemon
+$ ps aux
+jason            2408   0.1  0.2  2648176  13532 s003  S    12:14下午   0:00.02 you_sails_app    
+jason            2407   0.0  0.0  2604916   1016 s003  S    12:14下午   0:00.00 you_sails_app [master]
+$ sails restart
+$ sails stop
+```
 
 ## API Documents
 
-http://rdoc.info/github/huacnlee/sails
+http://www.rubydoc.info/github/huacnlee/sails
+
+
+## TODO
+
+- [ ] Reload without restart;
+- [ ] Scaffold generator;
+- [X] Multi processes;

data/lib/sails/base.rb

@@ -1,38 +1,71 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'active_support/all'
-require 'i18n'
-require 'thrift'
-require 'yaml'
-
 Bundler.require()
 
 module Sails
   extend ActiveSupport::Autoload
+  
+  autoload :Config
 
-  class Config
-    include ActiveSupport::Configurable
-  end
-
+  # Sails.config
+  #
+  # Configs with Sails
+  # For example:
+  #
+  #   Sails.config.app_name
+  #   # => returns "You App Name"
+  #
+  #   Sails.config.autoload_paths
+  #   # => returns ['app/models','app/models/concerns', 'app/workers', 'app/services'...]
+  #
+  #   Sails.config.cache_store = [:dalli_store, '127.0.0.1', { pool_size: 100 }]
+  #   Sails.config.i18n.default_locale = 'zh-CN'
+  #
   def self.config
     return @config if defined?(@config)
     @config = Config.new.config
-    @config.app_name = "Sails"
-    @config.cache_store = [:memory_store]
-    @config.autoload_paths = %W(app/models app/models/concerns app/workers app/services app/services/concerns lib)
-    @config.i18n = I18n
-    @config.i18n.load_path += Dir[Sails.root.join('config', 'locales', '*.{rb,yml}').to_s]
-    @config.i18n.default_locale = :en
-    @config.thrift_processor = nil
-    @config
   end
 
+  # Sails.cache
+  #
+  # An abstract cache store class. There are multiple cache store
+  # implementations, each having its own additional features. See the classes
+  # under the ActiveSupport::Cache module, e.g.
+  # ActiveSupport::Cache::MemCacheStore. MemCacheStore is currently the most
+  # popular cache store for large production websites.
+  #
+  # Some implementations may not support all methods beyond the basic cache
+  # methods of +fetch+, +write+, +read+, +exist?+, and +delete+.
+  #
+  # ActiveSupport::Cache::Store can store any serializable Ruby object.
+  #
+  #   Sails.cache.read('city')   # => nil
+  #   Sails.cache.write('city', "Duckburgh")
+  #   Sails.cache.read('city')   # => "Duckburgh"
+  #
+  # Keys are always translated into Strings and are case sensitive. When an
+  # object is specified as a key and has a +cache_key+ method defined, this
+  # method will be called to define the key.  Otherwise, the +to_param+
+  # method will be called. Hashes and Arrays can also be used as keys. The
+  # elements will be delimited by slashes, and the elements within a Hash
+  # will be sorted by key so they are consistent.
+  #
+  #   Sails.cache.read('city') == Sails.cache.read(:city)   # => true
+  #
+  # Nil values can be cached.
   def self.cache
     return @cache if defined?(@cache)
     @cache = ActiveSupport::Cache.lookup_store(self.config.cache_store)
   end
 
   # Sails.root
+  #
+  # This method returns a Pathname object which handles paths starting with a / as absolute (starting from the root of the filesystem). Compare:
+  #
+  # For example:
+  #   >> Sails.root
+  #   => #<Pathname:/some/path/to/project>
+  #   >> Sails.root + "file"
+  #   => #<Pathname:/some/path/to/project/file>
+  #
   def self.root
     @root ||= Pathname.new(Dir.pwd)
   end
@@ -41,11 +74,30 @@ module Sails
     @root = Pathname.new(root)
   end
 
-  # Sails.env.development?
+  # Sails.env
+  #
+  # returns a string representing the current Sails environment.
+  # This will read from ENV['RAILS_ENV'] like Rails
+  #
+  # For example:
+  #
+  #     Sails.env # in development mode
+  #     => "development"
+  #     Sails.env.development?
+  #     => true
+  #
   def self.env
     @env ||= ActiveSupport::StringInquirer.new(ENV['RAILS_ENV'].presence || 'development')
   end
 
+  # Sails.logger
+  #
+  # returns a Logger class
+  # For example:
+  #
+  #     Sails.logger.info "Hello world"
+  #     Sails.logger.error "Hello world"
+  #
   def self.logger
     return @logger if defined?(@logger)
     @logger = Logger.new(File.join(Sails.root, "log/#{self.env}.log"))
@@ -56,21 +108,6 @@ module Sails
     @logger
   end
 
-  def self.stdout_logger
-    return @stdout_logger if defined?(@stdout_logger)
-    @stdout_logger = Logger.new(STDOUT)
-    @stdout_logger.formatter = proc { |severity, datetime, progname, msg|
-      "#{msg}\n"
-    }
-    @stdout_logger
-  end
-
-  def self.load_initialize
-    Dir["#{Sails.root}/config/initializers/*.rb"].each do |f|
-      require f
-    end
-  end
-
   def self.init
     $:.unshift self.root.join("lib")
     # init root
@@ -80,7 +117,7 @@ module Sails
 
     ActiveSupport::Dependencies.autoload_paths += Sails.config.autoload_paths
 
-    env_file = self.root.join('config/environments/',Sails.env)
+    env_file = self.root.join('config/environments/',Sails.env + ".rb")
     if File.exist?(env_file)
       require env_file
     end
@@ -93,31 +130,80 @@ module Sails
     @inited = true
   end
 
+  # Sails.service
+  #
+  # return a instance of Sails Service layer
+  #
+  # for example:
+  #
+  #     class UsersService < Sails::Service::Base
+  #       def check_name_exist?(name)
+  #         User.check_name_exist?(name)
+  #       end
+  #     end
+  #
+  #     class UsersServiceTest
+  #       def test_check_name_exist?
+  #         assert_equal(Sails.service.check_name_exist?(name), true) 
+  #       end
+  #     end
+  #
+  def self.service
+    @service ||= Sails::Service::Interface.new
+  end
+  
+  # Force reload Sails cache classes in config.autoload_paths
+  def self.reload!(opts = {})
+    force = opts[:force] || false
+    if force || config.cache_classes == false
+      @service = nil
+      ActiveSupport::Dependencies.clear
+      reload_server!
+    end
+  end
+
+  def self.reload_server!
+    if @server
+      new_processor = config.processor.new(self.service)
+      @server.instance_variable_set(:@processor, new_processor)
+    end
+  end
+  
   def self.start!(type)
-    if type == "thread"
+    @server_type = type
+    if @server_type == "thread"
       start_thread_pool_server!
     else
       start_non_blocking_server!
     end
   end
-
-  def self.service
-    @service ||= Sails::Service.new
+  
+  def self.thrift_protocol_class
+    case config.protocol
+    when :compact
+      return ::Thrift::CompactProtocolFactory
+    when :json
+      return ::Thrift::JsonProtocolFactory
+    else 
+      return ::Thrift::BinaryProtocolFactory
+    end
   end
 
+  # Start Thrift Server with Threaded mode
+  #
   def self.start_thread_pool_server!
-    transport = ::Thrift::ServerSocket.new(nil, config.thrift_thread_port)
+    transport = ::Thrift::ServerSocket.new(nil, config.thread_port)
     transport_factory = ::Thrift::BufferedTransportFactory.new
-    protocol_factory = ::Thrift::BinaryProtocolFactory.new
-    processor = config.thrift_processor.new(self.service)
-    server = ::Thrift::ThreadPoolServer.new(processor, transport, transport_factory, protocol_factory, Setting.pool_size)
+    protocol_factory = thrift_protocol_class.new
+    processor = config.processor.new(self.service)
+    @server = ::Thrift::ThreadPoolServer.new(processor, transport, transport_factory, protocol_factory, config.thread_size)
 
     puts "Boot on: #{Sails.root}"
     puts "[#{Time.now}] Starting the Sails with ThreadPool size: #{Setting.pool_size}..."
-    puts "serve: #{config.thrift_host}:#{config.thrift_thread_port}"
+    puts "serve: 127.0.0.1:#{config.thread_port}"
 
     begin
-      server.serve
+      @server.serve
     rescue => e
       puts "Start thrift server exception! \n  #{e.inspect}"
       puts e.backtrace
@@ -129,19 +215,21 @@ module Sails
     end
   end
 
+  # Start Thrift Server with Event drive mode
   def self.start_non_blocking_server!
-    transport = ::Thrift::ServerSocket.new(nil, config.thrift_port)
+    transport = ::Thrift::ServerSocket.new(nil, config.port)
     transport_factory = ::Thrift::FramedTransportFactory.new
-    protocol_factory = ::Thrift::BinaryProtocolFactory.new
-    processor = config.thrift_processor.new(self.service)
-    server = ::Thrift::NonblockingServer.new(processor, transport, transport_factory)
+    protocol_factory = thrift_protocol_class.new
+    processor = config.processor.new(self.service)
+    @server = ::Thrift::NonblockingServer.new(processor, transport, transport_factory, protocol_factory, config.thread_size)
 
     puts "Boot on: #{Sails.root}"
     puts "[#{Time.now}] Starting the Sails with NonBlocking..."
-    puts "serve: #{config.thrift_host}:#{config.thrift_port}"
+    puts "Protocol: #{thrift_protocol_class.name}"
+    puts "serve: 127.0.0.1:#{config.port}"
 
     begin
-      server.serve
+      @server.serve
     rescue => e
       puts "Start thrift server exception! \n  #{e.inspect}"
       puts e.backtrace
@@ -152,4 +240,22 @@ module Sails
       end
     end
   end
-end
+  
+  private
+  def self.stdout_logger
+    return @stdout_logger if defined?(@stdout_logger)
+    @stdout_logger = Logger.new(STDOUT)
+    @stdout_logger.formatter = proc { |severity, datetime, progname, msg|
+      "#{msg}\n"
+    }
+    @stdout_logger
+  end
+
+  def self.load_initialize
+    Dir["#{Sails.root}/config/initializers/*.rb"].each do |f|
+      require f
+    end
+  end
+end
+
+Sails.init()

data/lib/sails/cli.rb

@@ -2,76 +2,12 @@ require 'thor'
 require 'sails/version'
 
 module Sails
-  class ThreadDaemon
-    class << self
-      attr_accessor :options, :mode, :app_name, :pid_file
-
-      def init(opts = {})
-        self.app_name = Sails.config.app_name
-        self.mode = opts[:mode]
-        self.app_name = "#{ThreadDaemon.app_name}-thread" if self.mode == "thread"
-        self.pid_file = Sails.root.join("tmp/#{ThreadDaemon.app_name}.pid")
-        self.options = options
-      end
-
-      def read_pid
-        if !File.exist?(pid_file)
-          return nil
-        end
-
-        pid = File.open(pid_file).read.to_i
-        begin
-          Process.getpgid(pid)
-        rescue
-          pid = nil
-        end
-        return pid
-      end
-
-      def start_process(options = {})
-        $PROGRAM_NAME = self.app_name
-        old_pid = read_pid
-        if old_pid != nil
-          puts "Current have #{app_name} process in running on pid #{old_pid}"
-          return
-        end
-
-        pid = fork do
-          Sails.start!(self.mode)
-        end
-        File.open(pid_file, "w+") do |f|
-          f.puts pid
-        end
-
-        puts "Started #{app_name} on pid: #{pid}"
-
-        if options[:daemon] == false
-          Process.waitpid(pid)
-        end
-      end
-
-      def stop_process
-        pid = read_pid
-        if pid == nil
-          puts "#{app_name} process not found, pid #{pid}"
-          return
-        end
-
-        print "Stopping #{app_name} with pid: #{pid}..."
-        begin
-          Process.kill("QUIT", pid)
-        ensure
-          File.delete(pid_file)
-        end
-        puts " [Done]"
-      end
-    end
-  end
-
   class CLI < Thor
     include Thor::Actions
     
     map '-v' => :version
+    map 's' => :start
+    map 'c' => :console
 
     def self.source_root
       __dir__
@@ -83,27 +19,36 @@ module Sails
       end
     }
 
+    # sails start
+    #
+    # Start a thrift app server
     option :daemon, type: :boolean, default: false
     option :mode, default: 'nonblocking'
     desc "start", "Start Thrift server"
     def start()
-      ThreadDaemon.init(mode: options[:mode])
-      ThreadDaemon.start_process(daemon: options[:daemon])
+      Sails::Daemon.init(mode: options[:mode])
+      Sails::Daemon.start_process(daemon: options[:daemon])
     end
 
+    # sails stop
+    #
+    # Stop thrift app server
     option :mode, default: 'nonblocking'
     desc "stop", "Stop Thrift server"
     def stop()
-      ThreadDaemon.init(mode: options[:mode])
-      ThreadDaemon.stop_process
+      Sails::Daemon.init(mode: options[:mode])
+      Sails::Daemon.stop_process
     end
-
+    
+    # sails restart
+    #
+    # Restart thrift app server
     option :mode, default: 'nonblocking'
     desc "restart", "Restart Thrift server"
     def restart()
-      ThreadDaemon.init(mode: options[:mode])
-      ThreadDaemon.stop_process
-      ThreadDaemon.start_process(daemon: true)
+      Sails::Daemon.init(mode: options[:mode])
+      Sails::Daemon.stop_process
+      Sails::Daemon.start_process(daemon: true)
     end
 
     desc "new APP_NAME", "Create a project"
@@ -125,6 +70,11 @@ module Sails
       @rel_dir = nil
     end
     
+    desc "console", "Enter Sails console"
+    def console
+      Sails::Console.start(Sails.root.join("config/application.rb"))
+    end
+    
     desc "version", "Show Sails version"
     def version
       puts "Sails #{Sails.version}"

data/lib/sails/config.rb

@@ -0,0 +1,25 @@
+module Sails
+  class Config
+    include ActiveSupport::Configurable
+    
+    def initialize
+      init_defaults!
+    end
+    
+    def init_defaults!
+      config.app_name = "Sails"
+      config.cache_store = [:memory_store]
+      config.autoload_paths = %W(app/models app/models/concerns app/workers app/services app/services/concerns lib)
+      config.i18n = I18n
+      config.i18n.load_path += Dir[Sails.root.join('config', 'locales', '*.{rb,yml}').to_s]
+      config.i18n.default_locale = :en
+      config.cache_classes = false
+      
+      config.port = 4000
+      config.thread_port = 4001
+      config.processor = nil
+      config.thread_size = 20
+      config.protocol = :binary
+    end
+  end
+end

data/lib/sails/console.rb

@@ -0,0 +1,44 @@
+require "irb"
+require "irb/ext/loader"
+
+module Sails
+  module ConsoleMethods
+    extend ActiveSupport::Concern
+    
+    included do
+    end
+    
+    def service
+      Sails.service
+    end
+    
+    def reload!
+      puts "Reloading..."
+      Sails.reload!(force: true)
+      return true
+    end
+  end
+  
+  class Console
+    class << self
+      def start(app_path)
+        new(app_path).start
+      end
+    end
+    
+    def initialize(app_path)
+      @app_path = app_path
+    end
+    
+    def start
+      puts "Loading #{Sails.env} environment (Sails #{Sails.version})"
+      IRB.conf[:IRB_NAME] = "Sails console"
+      require @app_path
+      ARGV.clear
+      if defined?(IRB::ExtendCommandBundle)
+        IRB::ExtendCommandBundle.send :include, Sails::ConsoleMethods
+      end
+      IRB.start()
+    end
+  end
+end