twirp_rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f76a67c6644535dc835e68bb6b47b28661dca6922b9733653f0480e297f65bb1
-  data.tar.gz: f0a855d0cb9d1a0b693e5b11c03d7bdca9486ff12bf82ac103298bfdf67dfe88
+  metadata.gz: 6a7d8c6c8308b619d98a8719ec069a0896ba0997145646dec8d3be46b92bd3f5
+  data.tar.gz: f3211a52b907e61e49f546f5f34202b5a4e870b56d23f72fca8a28c877277a2b
 SHA512:
-  metadata.gz: 22b8a3a2c75e2a5084a5184c1137726ce3f8978f111a2cd1749028492276b518ab2c03b19e799d9ec858023fe51ce01d79f6d7702357e761ec555e90ac832a5b
-  data.tar.gz: 87bf3f8cc09b9694cdc1f949de56d38f1a6283bc2d6237b0e06f75b15266c4009015a13efa6f74966623d01db2773cc3e4a51fb7bce17401b14830f78c795d4d
+  metadata.gz: b8bc55ff11f35137d883335e92b0d49e50d7bafa75e5a9c7dab9f1632366a71379ff88093709dcccc08b2a2f643c9c2f637448cc6101b898f8c2faa7dd1c22f1
+  data.tar.gz: e94cff9b2181e4a46343f2a3f0be10fdee43ab88217ca91d01626375f721adffdf39237beab652b8c6c1cd8760abb1f110d68ab6cc92a024437093f2154d2e13

data/CHANGELOG.md

@@ -4,11 +4,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.1.3 - 2020-01-28
+## 0.1.4 - 2020-02-03
 
 ### Added
 - convert package.message type to Package::Message
 
+## 0.1.3 - 2020-01-28
+
+### Added
+- ```to_twirp``` and ```twirp_message``` methods to easy convert active record models to protobuf DTOs
+- rspec helper to test twirp handlers with ```rpc``` helper
+```ruby
+config.include TwirpRails::RSpec::Helper, type: :rpc, file_path: %r{spec/rpc}
+# ...
+
+describe TeamsHandler do
+  let!(:team) { create :team }
+
+  context '.get' do
+    rpc { [:get, id: team.id] }
+
+    it { should match(team: team.to_twirp.symbolize_keys) }
+  end
+end
+``` 
+
 ### Fixed
 - twirp_ruby missing module workaround https://github.com/twitchtv/twirp-ruby/issues/48
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.1.3)
+    twirp_rails (0.1.4)
       railties (~> 6.0)
       twirp (~> 1)
 

data/lib/twirp_rails/active_record_extension.rb

@@ -0,0 +1,58 @@
+module TwirpRails
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Using to set twirp class used by to_twirp method
+      # @example
+      # twirp_message TwirpModel
+      def twirp_message(message_class)
+        @twirp_message = message_class
+      end
+
+      def twirp_message_class
+        @twirp_message = @twirp_message.constantize if @twirp_message.is_a?(String)
+
+        @twirp_message
+      end
+
+      def to_twirp(*args)
+        all.map { |entity| entity.to_twirp(*args) }
+      end
+    end
+
+    # Converts to twirp hash,
+    # @return [Hash] of attributes
+    # used by relation method to_twirp
+    # @param [Array|Class] fields_or_class - array of converted fields or message class to
+    def to_twirp(*fields_or_class)
+      fields = fields_or_class
+      result = attributes
+
+      if fields.empty? && self.class.twirp_message_class
+        fields = [self.class.twirp_message_class]
+      end
+
+      if fields.one? && fields.first.is_a?(Class)
+        message_class = fields.first
+
+        unless message_class.respond_to?(:descriptor)
+          raise "Class #{message_class} must me a protobuf message class"
+        end
+
+        # TODO performance optimization needed
+        fields = message_class.descriptor.map &:name
+
+        result = result.slice(*fields)
+      elsif fields.any?
+        result = result.slice(*fields)
+      end
+
+      result
+    end
+  end
+end
+
+if defined? ActiveRecord::Base
+  ActiveRecord::Base.include TwirpRails::ActiveRecordExtension
+end

data/lib/twirp_rails/generators/twirp/twirp_generator.rb

@@ -8,7 +8,6 @@ class TwirpGenerator < Rails::Generators::NamedBase
 
   def check_requirements
     in_root do
-      puts `pwd`
       unless File.exists?(proto_file_name)
         raise "#{proto_file_name} not found #{`pwd`} #{`ls`}"
       end
@@ -64,7 +63,7 @@ class TwirpGenerator < Rails::Generators::NamedBase
   end
 
   def generate_rspec_files
-    puts 'RSpec TODO'
+    # TODO
   end
 
   private
@@ -73,14 +72,6 @@ class TwirpGenerator < Rails::Generators::NamedBase
     result_type.split('.').map(&:camelize).join('::')
   end
 
-  def from_rails_root(&block)
-    old_dir = Dir.pwd
-    Dir.chdir Rails.root
-    yield
-  ensure
-    Dir.chdir old_dir
-  end
-
   def protoc_cmd(files)
     FileUtils.mkdir_p 'lib/twirp'
     flags = "--proto_path=app/protos --ruby_out=lib/twirp --twirp_ruby_out=lib/twirp --plugin=#{PLUGIN_PATH}"

data/lib/twirp_rails/rspec/helper.rb

@@ -0,0 +1,56 @@
+module TwirpRails
+  module RSpec
+    module Helper
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # places to subject service method returned value converted to_h
+        # @param [Boolean] to_h - default true, set to false to use pure result
+        # @param [Proc] block - should return array with method name and arguments
+        # @example
+        #   rpc { [:get, id: 1] }
+        #   it { should match(id: 1)}
+        def rpc(to_h: true, &block)
+          let :rpc_args, &block
+          subject do
+            result = service.call_rpc(*rpc_args)
+            to_h ? result.to_h : result
+          end
+        end
+
+        def service_class_from_describe
+          result = metadata[:service]
+
+          result = result.constantize if result && !result.is_a?(Class)
+
+          result
+        end
+
+        def infer_service_class
+          service_class_name = described_class.name.gsub(/Handler$/, '') + 'Service'
+
+          service_class_name.constantize
+        rescue NameError
+          msg = "Cannot infer Service class from handler #{described_class.name}."
+          msg += " Inferred name #{service_class_name}" if service_class_name
+
+          raise msg
+        end
+
+        def service_class
+          @service_class ||=
+            service_class_from_describe || infer_service_class
+        end
+      end
+
+      def service_class
+        self.class.service_class
+      end
+
+      included do
+        let(:handler) { described_class.new }
+        let(:service) { service_class.new(handler) }
+      end
+    end
+  end
+end

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/lib/twirp_rails.rb

@@ -3,6 +3,7 @@
 require 'twirp_rails/version'
 require 'twirp_rails/engine'
 require 'twirp_rails/generators/twirp/twirp_generator'
+require 'twirp_rails/active_record_extension'
 
 module TwirpRails
   class Error < StandardError; end

data/twirp_rails.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(\.cicleci|bin|test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -139,14 +139,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/push
-- bin/setup
 - lib/twirp_rails.rb
+- lib/twirp_rails/active_record_extension.rb
 - lib/twirp_rails/engine.rb
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/twirp_generator.rb
 - lib/twirp_rails/routes.rb
+- lib/twirp_rails/rspec/helper.rb
 - lib/twirp_rails/twirp.rb
 - lib/twirp_rails/version.rb
 - twirp_rails.gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "twirp_rails"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/push

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -v
-
-rspec
-
-gem build twirp_rails.gemspec
-
-gem push twirp_rails-$(ruby -r./lib/twirp_rails/version.rb -e "print TwirpRails::VERSION").gem

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here