Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support proper parse the file name in mingw platform. #1014

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@ if version == "master"
else
gem "rails", "~> #{version}.0"
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

jruby doesn't either? or jruby on windows?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bf4 it's just copy from Railties app template, not known jruby status.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, then that works for me. Since we don't have a Gemfile.lock in version control, we don't even need to edit that.

25 changes: 23 additions & 2 deletions lib/active_model/serializer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,22 @@ class Serializer
include Configuration
include Associations


# Matches
# "c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `<top (required)>'"
# AND
# "/c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb:1:in `<top (required)>'"
# AS
# c/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb
CALLER_FILE = /
\A # start of string
\S+ # one or more non-spaces
(?= # stop previous match when
:\d+ # a colon is followed by one or more digits
:in # followed by a colon followed by in
)
/x

class << self
attr_accessor :_attributes
attr_accessor :_attributes_keys
Expand All @@ -29,8 +45,7 @@ def self.inherited(base)
base._attributes = self._attributes.try(:dup) || []
base._attributes_keys = self._attributes_keys.try(:dup) || {}
base._urls = []
serializer_file = File.open(caller.first[/^[^:]+/])
base._cache_digest = Digest::MD5.hexdigest(serializer_file.read)
base._cache_digest = digest_caller_file(caller.first)
super
end
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs a test!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😈 (yay!)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, be seriously, there is already testing existing, but the problem is if you not running in Windows, c:/git won't return to you from ruby side, so it's really hard to write a test to testing that case in Linux.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bf4 So if you really care about Windows user, just merge this PR and I will propose another to fix testing suite in windows, because even current testing case is not all pass in windows...
error

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you really care about Windows user

Of course I care. No reason not add a regression test

Also, I'm not a collab so I can't merge it sorry :)

@kurko @joaomdmoura Let's see if we can set up an appveyor account to test on windows. I know RSpec does this and it works pretty well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

using the appveyor is right, since current testing case running in windows can already cover this problem.

But seems its complex and really necessory? Just relay on me should enough, I will definitely working on windows and always report/fix issue if found.

As Windows user, really don't expect we will be regarded as first class support tie like Mac/Linux in Rails ecosystem. 😭


Expand Down Expand Up @@ -161,6 +176,12 @@ def self.serializers_cache
@serializers_cache ||= ThreadSafe::Cache.new
end

def self.digest_caller_file(caller_line)
serializer_file_path = caller_line[CALLER_FILE]
serializer_file_contents = IO.read(serializer_file_path)
Digest::MD5.hexdigest(serializer_file_contents)
end

attr_reader :options

def self.get_serializer_for(klass)
Expand Down
6 changes: 5 additions & 1 deletion test/generators/serializer_generator_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ def test_generates_attributes_and_associations
def test_with_no_attributes_does_not_add_extra_space
run_generator ["account"]
assert_file "app/serializers/account_serializer.rb" do |content|
assert_no_match /\n\nend/, content
if RUBY_PLATFORM =~ /mingw/
assert_no_match /\r\n\r\nend/, content
else
assert_no_match /\n\nend/, content
end
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Eric-Guo you can just assert_no_match /\r?\n\r?\nend/, content

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can not write like assert_no_match /\r?\n\r?\nend/, content, because will cause below error.

  1) Failure:
SerializerGeneratorTest#test_with_no_attributes_does_not_add_extra_space [c:/git/emberjs/active_model_serializers/test/g
enerators/serializer_generator_test.rb:48]:
Expected /\r?\n\r?\nend/ to not match "\nclass AccountSerializer < ActiveModel::Serializer\n  attributes :id\n\nend\n\n"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or if you want to get wild

# record_separator = $-0 == $/
assert_no_match /#{record_separator}#{record_separator}end/, content

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$-0 are also '\n', same as unix, maybe ruby bug?
crlf

end
end
end
27 changes: 26 additions & 1 deletion test/serializers/cache_test.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
require 'test_helper'
require 'tempfile'
module ActiveModel
class Serializer
class CacheTest < Minitest::Test
Expand Down Expand Up @@ -125,10 +126,34 @@ def test_uses_file_digest_in_cache_key
assert_equal(@blog_serializer.attributes, ActionController::Base.cache_store.fetch(@blog.cache_key_with_digest))
end

def _cache_digest_definition
def test_cache_digest_definition
assert_equal(::Model::FILE_DIGEST, @post_serializer.class._cache_digest)
end

def test_serializer_file_path_on_nix
path = "/Users/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb"
caller_line = "#{path}:1:in `<top (required)>'"
assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
end

def test_serializer_file_path_on_windows
path = "c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb"
caller_line = "#{path}:1:in `<top (required)>'"
assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
end

def test_digest_caller_file
contents = "puts 'AMS rocks'!"
file = Tempfile.new("some_ruby.rb")
file.write(contents)
path = file.path
caller_line = "#{path}:1:in `<top (required)>'"
file.close
assert_equal ActiveModel::Serializer.digest_caller_file(caller_line), Digest::MD5.hexdigest(contents)
ensure
file.unlink
end

private
def render_object_with_cache(obj)
ActiveModel::SerializableResource.new(obj).serializable_hash
Expand Down