gemfileparser / gemfileparser

A library to parse Ruby Gemfile, .gemspec and Cocoapod .podspec file using Python.

gemfileparser

gemfileparser parses Ruby Gemfile using Python with supports Ruby Gemfiles and .gemspec files as well as Cocoapod .podspec files.

Installation

In a virtualenv, use the command:

pip install gemfileparser

Otherwise from a git clone, use the following commands in a virtualenv:

git clone https://github.com/gemfileparser/gemfileparser.git
cd gemfileparser
python setup.py install

Usage

from gemfileparser import GemfileParser
parser = GemfileParser(<path to Gemfile>, <name of the application (optional)>)
dependency_dictionary = parser.parse()

The parse() method returns a dict object of the following format:

{
    'development': [list of dependency objects inside group 'development'],
    'runtime': [list of runtime dependency objects],
    .
    .
}

Each dependency object contains the following attributes:

• name - Name of the gem
• requirement - Version requirement
• autorequire - Autorequire value
• source - Source URL of the gem
• parent - Dependency of which gem
• group - Group that a gem is a member of (default : runtime)

Example

from gemfileparser import GemfileParser
n = GemfileParser('Gemfile', 'diaspora')
deps = n.parse()
for key in deps:
   if deps[key]:
       print key
       for dependency in deps[key]:
           print("\t", dependency)

Tests

Do this to run tests:

pip install -e .
pip install pytest
pytest -vvs tests

Copyright

• Copyright (c) 2020 Gemfileparser authors (listed in AUTHORS file)
• Copyright (c) 2015-2018 Balasankar C <[email protected]>

License

gemfileparser is dual-licensed under your choice of the GNU GPL version 3 (or later) License or the MIT License.

It is preferred anyone using this project to respect the GPL-3+ license and use that itself for derivative works - thus making them also Free Software. But, your call.

When making contributions to gemfileparser you agree to license these contributions under the same choice of licenses.

gemfileparser's Issues

Full access to PyPI

@balasankarc Hi!
I am reaching out because I do not have full access to the PyPI project for gemfileparser; in particular I cannot manage releases and add secondary maintainers.

As a result for now, we are maintaining an updated fork in https://github.com/nexB/gemfileparser2 and released it to PyPI as https://pypi.org/project/gemfileparser2/

That's not an ideal situation, but that's all I can do short of having full rights on PyPI.
Can you give me full access?

Support for Gemfiles with arbitrary ruby code

Hi folks 👋

I am looking for a solution that allows me to parse the dependencies of some ruby project that uses bundler and Gemfileparser looks promising.

What Happened

I tried running against https://github.com/3scale/porta/blob/master/Gemfile , but I only get 2 results:

development :
runtime :
	 <gemfileparser.Dependency object at 0x10457f2e0>
	 <gemfileparser.Dependency object at 0x10457f370>
dependency :
test :
production :
metrics :

Presumably this is because https://github.com/3scale/porta/blob/master/Gemfile#L3 includes another Gemfile.

What I Expected to Happen

I would like the list of results to include both the results in Gemfile, but also those from Gemfile.base.

Potential Solutions Considered

I am wondering if you have already considered parsing Gemfile.lock rather than Gemfile, as a way of parsing a more standard format that doesn't, essentially, require Gemfileparser to support evaluating arbitrary ruby code (this would open up to a series of other issues).

Of course, parsing just Gemfile.lock would mean no support for dependency groups, but perhaps that is an acceptable tradeoff.. ?

Any thoughts on this topic?

License for use as a library?

@balasankarc This is a request to ask if you could consider may be using an alternative license such that your code could be used as a library in a non-GPL project, possibly an LGPL?
I have already built a Gemfile.lock parser here https://github.com/nexB/scancode-toolkit-contrib/tree/develop/src/packagedcode2 and also a Ruby-based parser that spawn from Python for gemspec, but I would very much prefer using a pure Python approach.

Thank you for your kind consideration!

list index out of range

I get list index out of range exception when try to parse this file:
https://github.com/plataformatec/devise/blob/master/Gemfile (looks like it happens because there is no '.gemspec' file in a folder.

RFC: Renaming master branch to main

I plan to renamed master branch to main.
Any objection?

@rpotter12 @balasankarc ?

Latest release on PyPi

@balasankarc Latest version on PyPi is 0.6.2 and latest tag on github is 0.7.0.
Please release the latest tag on PyPi too :)

Incorrect dependency attributes assignment

Attributes are not correctly assigned on dependency on lines like that:
'gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]'

I already have created corresponding change, if you give me access rights, I'll create patch myself. If not, here, file with fix, branched from master:
https://pastebin.com/Eu9QgnKR
Please, add this fix to correctly parse dependencies from manifests like this one:
https://github.com/rails/rails/blob/master/Gemfile

Remove runtime dependency on nose

See https://github.com/balasankarc/gemfileparser/blob/71b1948f3396a62dee87e50cab65db28522f7666/setup.py#L85

Parse version specifications

There is a bit of useful logic at
https://github.com/mfwarren/gemparser/blob/master/src/gemparser/__init__.py

But better would be to use rubymarshal for parsing the version, but be aware of d9pouces/RubyMarshal#3