Html rendering

[lolgear]

Architecture changed.

1. Base class Generator added.
2. Module Auxiliaries added which contains file handling operations. Could be merged into base class Generator.
3. HTMLGenerator added.
4. Plist and HTML Writers added which handles output to appropriate file format.

[segiddins]

please don't commit these .ruby-* files

[lolgear]

@segiddins
add to gitignore or just do not commit them?

[segiddins]

either is OK

[segiddins]

if at all possible, we really should avoid a dependency on nokogiri, since many have issues installing it

[lolgear]

@segiddins ok, html is too simple to use nokogiri.

[segiddins]

trailing newline

[lolgear]

@segiddins
maybe add 'rubocop' to development group to solve style questions?

[segiddins]

indentation

[segiddins]

trailing newlines missing in all these files, everything should also be using 2 spaces for indentation

[lolgear]

@segiddins updated.
nokogiri dependency removed.

[hamdshah]

Any chance of merging this branch ?

[orta]

I don't think it's done, see: https://github.com/CocoaPods/cocoapods-acknowledgements/pull/47/files#diff-86a5d812fd9ecac367ea96aaa1964994R4

[lolgear]

@orta
It is an obsoleted class. ( or duplicate ). I use PlistGenerator instead. They are identical in terms of Model.
You can check invocations of HTMLGenerator. Maybe anybody can figure out what we can do with it in future. For now it is empty and it copies whole body of PlistGenerator. ( yeah, copy-paste is evil ).

Update:
HTMLWriter consumes PlistGenerator::SpecObject to generate correct output.

[lolgear]

Weird, build error.

Bundler could not find compatible versions for gem "bundler":
  In Gemfile:
    bundler (~> 1.3)
  Current Bundler version:
    bundler (2.0.1)

[segiddins]

commented-out code

[segiddins]

missing newline

[krin-san]

Would be nice to pass render_options to HTML render using user_settings parameter of cocoapods-acknowledgements plugin. Current implementation don't wrap http[s] links with a HTML tag which makes them hard to style.

[lolgear]

@krin-san How to retrieve user_settings?

[krin-san]

Sorry, I mistyped – it's named user_options. This hash contains any custom parameters user might define in plugin inclusion string. E.g.:

plugin 'cocoapods-acknowledgements', :settings_bundle => true

We can use user_options as a source of extra parameters for Redcarpet::Render::HTML. Example:

plugin 'cocoapods-acknowledgements', :html_render_options => {:no_links => false, :link_attributes => {"link" => "#C0C0C0", "vlink" => "#808080", "alink" => "#FF0000"}}

Just need to figure out how to pass html_render_options through HTMLGenerator to MarkdownParser.

[lolgear]

@krin-san We can extend self.generate method in Generator to accept another parameter options.

      def generate_specs(target_description, sandbox, excluded, root_specs, options = {})
        []
      end
      def generate(target_description, sandbox, excluded, options = {})
        root_specs = target_description.specs.map(&:root).uniq.reject {|spec| excluded.include?(spec.name)}
        return nil if root_specs.empty?
        generate_specs(target_description, sandbox, excluded, root_specs)
      end

I don't see any better option here.
What do you think?

[krin-san]

I'm not a Ruby developer actually 😄. Whichever option allowing to define render_options in Podfile plugin inclusion line looks fine for me.

[lolgear]

@segiddins Could you post a review?