francois / quicken_parser Goto Github PK

Hi there... I don't know if you still care about this code, but I found it and it looks like it'll help me with something, so I'm taking a look. Getting started, though, I noticed something that I would have expected to work which doesn't... and it's an easy fix, so:

If I have code like:

QuickenParser.parse('/path/to/some.qfx')

I'll get an error something like*:

Traceback (most recent call last):
        3: from [ruby-install-path]/gems/quicken_parser-0.2.1/lib/quicken_parser.rb:9:in `parse'
        2: from [ruby-install-path]/gems/quicken_parser-0.2.1/lib/quicken_parser/parser.rb:13:in `parse'
        1: from [ruby-install-path]/gems/quicken_parser-0.2.1/lib/quicken_parser/parser.rb:85:in `normalize_line_endings!'
[ruby-install-path]/gems/quicken_parser-0.2.1/lib/quicken_parser/parser.rb:85:in `gsub!': can't modify frozen String (FrozenError)

I know this differs a bit from the usage documented in the README, but hopefully you'll agree it's a natural enough usage.

The fix I've come up with for myself, which you're welcome to incorporate (I may also follow this up with a pull request, in case that's easier), is expressed by the following patch:

diff --git a/lib/quicken_parser/parser.rb b/lib/quicken_parser/parser.rb
index d94c517..e95053c 100644
--- a/lib/quicken_parser/parser.rb
+++ b/lib/quicken_parser/parser.rb
@@ -4,7 +4,8 @@ require "time"
 module QuickenParser
   class Parser #:nodoc:
     def initialize(source)
-      @input = source.respond_to?(:read) ? source.read : source
+      @input = source.respond_to?(:read) ? source.read :
+        File.exists?(source) ? File.open(source).read : source
     end
 
     def parse

As a side-note, you may notice that the errors above indicate a gem version of 0.2.1, yet the code in this repo is labeled 0.2.0. I don't know where 0.2.1 came from, as I couldn't find it in any of the forks. @agilous's fork has a 0.2.0.1 , but it's not the same. And there are real differences between 0.2.0 and 0.2.1... I've created a branch called gem_installed-0.2.1 in my fork to capture it, in case you want to look. It's getting rid of some code you added, presumably intentionally, so I'm basing the PR on what's otherwise in this repo, but I'd be happy to do a version based on that change instead, if that's better.

PR to follow. Thanks for creating this!

• error text modified slightly to obscure personal pathnames that I believe to be irrelevant.

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.