notebroker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 966658274251d2f4ada02bd952ea13089c823290073ba9920abf7450aaa6f84b
+  data.tar.gz: 6efd22a408432c4d3becb0f06de6694366d86c93f633553730c3f19e03e89439
+SHA512:
+  metadata.gz: 9322946fac86264abc9e05431633c8923c822a85fdad23c66796cd97550e93fb8c2d79453d77822be142765ac072ae08691c5b0ebd06531154c7c27087df58d6
+  data.tar.gz: e13c1d6d050e531d1a355d624dc251f9165eb1bf212bcdd4659039ac1760e658fa21561d7ea7e0ffdacb055ff268a68da982e42e7348b426255471918056c43b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,490 @@
+require: 
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+# ==================== Main ==========================
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true
+  Exclude:
+    - "bin/**/*"
+    - "db/schema.rb"
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+Bundler/InsecureProtocolSource:
+  AllowHttpProtocol: false
+Gemspec/DateAssignment:
+  Enabled: true
+Gemspec/RequireMFA:
+  Enabled: true
+Layout/BeginEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: begin
+Layout/CaseIndentation:
+  IndentOneStep: true
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - extend
+      - include
+      - prepend
+    associations:
+      - belongs_to
+      - has_one
+      - has_many
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - associations
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_methods
+    - private_methods
+Layout/CommentIndentation:
+  AllowForAlignment: true
+Layout/EmptyLineAfterMultilineCondition:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+  AllowAliasSyntax: false
+  AllowedMethods: []
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+Layout/FirstMethodParameterLineBreak:
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+  IndentationWidth: 0
+Layout/LineLength:
+  Max: 100
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+  EnforcedStyle: same_line
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+Layout/RedundantLineBreak:
+  Enabled: false
+Layout/SingleLineBlockChain:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Layout/TrailingWhitespace:
+  AllowInHeredoc: false
+Lint/AmbiguousAssignment:
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+Lint/AmbiguousRange:
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Enabled:  true
+Lint/DeprecatedConstants:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/DuplicateRequire:
+  Enabled: true
+Lint/ElseLayout:
+  Enabled: false
+Lint/EmptyBlock:
+  Enabled: true
+  AllowComments: false
+  AllowEmptyLambdas: false
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/EmptyFile:
+  Enabled: true
+  AllowComments: true
+Lint/EmptyInPattern:
+  Enabled: true
+  AllowComments: false
+Lint/EmptyWhen:
+  AllowComments: false
+Lint/FloatComparison:
+  Enabled: true
+Lint/HashCompareByIdentity:
+  Enabled: true
+Lint/IdentityComparison:
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/NumberedParameterAssignment:
+  Enabled: true
+Lint/OrAssignmentToConstant:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/RedundantDirGlobSort:
+  Enabled: true
+Lint/RedundantSafeNavigation:
+  Enabled: true
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/SymbolConversion:
+  Enabled: true
+Lint/ToEnumArguments:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+Lint/TripleQuotes:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/UnexpectedBlockArity:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Lint/UselessMethodDefinition:
+  Enabled: true
+  AllowComments: false
+Lint/UselessRuby2Keywords:
+  Enabled: true
+Lint/UselessTimes:
+  Enabled: true
+Lint/Void:
+  CheckForMethodsWithNoSideEffects: true
+Metrics/BlockLength:
+  IgnoredMethods:
+    - ips
+    - refine
+  Exclude:
+    - "**/*.gemspec"
+    - "spec/**/*"
+Metrics/ParameterLists:
+  Max: 3
+Naming/BlockForwarding:
+  Enabled: true
+Naming/InclusiveLanguage:
+  Enabled: true
+Naming/MethodName:
+  IgnoredPatterns:
+    - Array
+    - BigDecimal
+    - Complex
+    - Float
+    - Hash
+    - Integer
+    - JSON
+    - Pathname
+    - Rational
+    - String
+    - URI
+    - Version
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+  AllowedIdentifiers:
+    - capture3
+Naming/MethodParameterName:
+  AllowNamesEndingInNumbers: false
+Security/IoMethods:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArgumentsForwarding:
+  Enabled: false
+Style/ArrayCoercion:
+  Enabled: true
+Style/AndOr:
+  EnforcedStyle: conditionals
+Style/AutoResourceCleanup:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ClassEqualityComparison:
+  Enabled: true
+Style/ClassMethodsDefinitions:
+  Enabled: true
+Style/CombinableLoops:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/CollectionMethods:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/DocumentDynamicEvalDefinition:
+  Enabled: false
+Style/DoubleNegation:
+  EnforcedStyle: forbidden
+Style/EmptyLiteral:
+  Enabled: false
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+Style/EndlessMethod:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/FileRead:
+  Enabled: true
+Style/FileWrite:
+  Enabled: true
+Style/FormatStringToken:
+  EnforcedStyle: template
+Style/GlobalStdStream:
+  Enabled: false
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashConversion:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashExcept:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+  MinBranchesCount: 2
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+Style/ImplicitRuntimeError:
+  Enabled: true
+Style/InPatternThen:
+  Enabled: true
+Style/IpAddresses:
+  Enabled: true
+Style/KeywordParametersOrder:
+  Enabled: true
+Style/MapToHash:
+  Enabled: true
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+  EnforcedStyle: omit_parentheses
+  AllowParenthesesInChaining: true
+  AllowParenthesesInMultilineCall: true
+  IgnoreMacros: false
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+Style/MissingElse:
+  Enabled: false
+Style/MultilineInPatternThen:
+  Enabled: true
+Style/MultilineMethodSignature:
+  Enabled: true
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/NumberedParameters:
+  Enabled: true
+  EnforcedStyle: disallow
+Style/NumberedParametersLimit:
+  Enabled: true
+Style/NumericLiterals:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: true
+Style/OptionHash:
+  Enabled: true
+Style/OpenStructUse:
+  Enabled: true
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "[]"
+    "%W": "[]"
+    "%i": "[]"
+    "%I": "[]"
+    "%r": "()"
+Style/QuotedSymbols:
+  Enabled: true
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantSelfAssignment:
+  Enabled: true
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/ReturnNil:
+  Enabled: true
+Style/SafeNavigation:
+  Enabled: false
+Style/SelectByRegexp:
+  Enabled: true
+Style/Send:
+  Enabled: true
+Style/SignalException:
+  EnforcedStyle: semantic
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/SoleNestedConditional:
+  Enabled: true
+Style/StaticClass:
+  Enabled: true
+Style/StringChars:
+  Enabled: true
+Style/StringConcatenation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/StringMethods:
+  Enabled: true
+Style/SwapValues:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# ====================== Performance =======================
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+Performance/ConcurrentMonotonicTime:
+  Enabled: true
+Performance/ConstantRegexp:
+  Enabled: true
+Performance/IoReadlines:
+  Enabled: true
+Performance/MapCompact:
+  Enabled: true
+Performance/MethodObjectAsBlock:
+  Enabled: true
+Performance/OpenStruct:
+  Enabled: true
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/StringIdentifierArgument:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+Performance/Sum:
+  Enabled: true
+
+# ==================== RSpec ============================
+RSpec/BeEq:
+  Enabled: true
+RSpec/BeNil:
+  Enabled: true
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+RSpec/DescribeClass:
+  IgnoredMetadata:
+    type:
+      - feature
+      - request
+      - task
+RSpec/DescribedClassModuleWrapping:
+  Enabled: true
+RSpec/Dialect:
+  Enabled: true
+  PreferredMethods:
+    append_after: after
+    append_before: before
+    example: it
+    example_group: context
+    expect_any_instance_of: expect
+    is_expected: expect
+    its: it
+    let!: let
+    prepend_after: after
+    prepend_before: before
+    shared_examples_for: shared_examples
+    specify: it
+    subject!: subject
+RSpec/ExampleLength:
+  Max: 10
+RSpec/ExcessiveDocstringSpacing:
+  Enabled: true
+RSpec/FactoryBot/SyntaxMethods:
+  Enabled: false
+RSpec/IdenticalEqualityAssertion:
+  Enabled: true
+RSpec/NamedSubject:
+  IgnoreSharedExamples: false
+RSpec/Rails/AvoidSetupHook:
+  Enabled: true
+RSpec/StubbedMock:
+  Enabled: true
+RSpec/SubjectDeclaration:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "byebug"
+  gem "pry"
+  gem "rspec"
+  gem "rubocop"
+  gem "rubocop-performance"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+  gem "solargraph"
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    notebroker (0.1.0)
+      dry-cli
+      dry-initializer
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    dry-cli (0.7.0)
+    dry-initializer (3.1.1)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    nokogiri (1.13.3-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    regexp_parser (2.2.1)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    solargraph (0.44.3)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.10)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  byebug
+  notebroker!
+  pry
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  solargraph
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nolan J Tait
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Notebroker
+
+Supports turning ipynb python notebooks into the following formats:
+
+- Markdown
+
+This library is in alpha and might not support everything. You can see
+the example file which I will make harder over time at `spec/fixtures`.
+
+Plans are to support more formats like:
+
+- HTML
+- MDX
+
+I wrote this library to make it easier to write blog posts through NextJS
+using notebook code. Instead of dealing with the delicate javascript build
+ecosystem I decided to extract it into a more sane ruby gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'notebroker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install notebroker
+
+## Usage
+
+From your terminal you can run the cli:
+
+```
+notebroker --convert notebooks/my-notebook.ipynb --destination ./
+...
+Converting notebooks/my-notebook.ipynb into markdown...
+Saved markdown file to ./
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nolantait/notebroker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/notebroker/callable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Notebroker
+  module Callable
+    def call(args)
+      new(args).call
+    end
+  end
+end

data/lib/notebroker/cells/code.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Notebroker
+  module Cells
+    class Code
+      extend Dry::Initializer
+
+      param :input_lines
+      param :outputs
+
+      def to_markdown
+        return unless input_lines.any?
+
+        source = [].tap do |lines|
+          lines << wrap_code(input_lines, "python")
+          lines << wrap_code(output_lines, "shell") if output_lines.any?
+        end
+
+        source.flatten.join("\n")
+      end
+
+      private
+
+      def wrap_code(code, language)
+        [].tap do |lines|
+          lines << "```#{language}"
+          lines << normalize(code).join("\n")
+          lines << "```\n"
+        end
+      end
+
+      def normalize(code)
+        code.flatten.map do |line|
+          line.delete("\n")
+        end
+      end
+
+      def output_lines
+        outputs.reduce([]) do |lines, output|
+          lines << output[:text]
+        end
+      end
+    end
+  end
+end

data/lib/notebroker/cells/markdown.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Notebroker
+  module Cells
+    class Markdown
+      extend Dry::Initializer
+
+      param :lines
+
+      def to_markdown
+        return unless lines.any?
+
+        if lines.last[-1] == "\n"
+          lines.join
+        else
+          lines.join + "\n"
+        end
+      end
+    end
+  end
+end

data/lib/notebroker/cli.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Notebroker
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        desc "Print version"
+
+        def call(*)
+          puts Notebroker::VERSION
+        end
+      end
+
+      class Convert < Dry::CLI::Command
+        desc "Converts a ipynb file into the requested format"
+
+        argument :source, required: true, desc: "The source filepath"
+        option :destination,
+               type: :string,
+               default: "./",
+               desc: "The output filepath"
+
+        def call(source:, destination: "./")
+          File.write(
+            destination + "converted.md",
+            Notebroker.to_markdown(File.read(source))
+          )
+        end
+      end
+
+      register "version", Version, aliases: ["v", "-v", "--version"]
+      register "convert", Convert, aliases: ["c", "-c", "--convert"]
+      before("convert") do |args|
+        puts "Converting #{args.fetch(:source)} into markdown..."
+      end
+      after("convert") do |args|
+        puts "Saved markdown file to #{args.fetch(:destination, "./")}"
+      end
+    end
+  end
+end

data/lib/notebroker/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Notebroker
+  class Error < StandardError; end
+end

data/lib/notebroker/lexer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Notebroker
+  class Lexer
+    extend Callable
+    extend Dry::Initializer
+
+    param :lines
+
+    def call
+      lines.map do |cell|
+        case type = cell[:cell_type]
+          when "markdown" then Cells::Markdown.new(cell[:source])
+          when "code" then Cells::Code.new(
+            cell.fetch(:source, []),
+            cell.fetch(:outputs, [])
+          )
+          else
+            fail UnknownCellType, "No handler for #{type}"
+        end
+      end
+    end
+  end
+end

data/lib/notebroker/markdown.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Notebroker
+  class Markdown
+    extend Callable
+    extend Dry::Initializer
+
+    InvalidSource = Class.new(Error)
+
+    param :source
+
+    # @param String
+    def call
+      parsed = JSON.parse(source, symbolize_names: true)
+      result = Lexer.call(parsed[:cells])
+      result
+        .filter_map(&:to_markdown)
+        .join("\n")
+    rescue JSON::ParserError
+      raise InvalidSource
+    end
+  end
+end

data/lib/notebroker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Notebroker
+  VERSION = "0.1.0"
+end

data/lib/notebroker.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "json"
+require "dry-initializer"
+require "dry/cli"
+
+require_relative "notebroker/version"
+require_relative "notebroker/callable"
+require_relative "notebroker/error"
+require_relative "notebroker/cells/code"
+require_relative "notebroker/cells/markdown"
+require_relative "notebroker/lexer"
+require_relative "notebroker/markdown"
+require_relative "notebroker/cli"
+
+module Notebroker
+  def self.to_markdown(source)
+    Markdown.call(source)
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: notebroker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nolan J Tait
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+description: A ruby based CLI to turn python notebook ipynb files into other formats
+email:
+- nolanjtait@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/notebroker.rb
+- lib/notebroker/callable.rb
+- lib/notebroker/cells/code.rb
+- lib/notebroker/cells/markdown.rb
+- lib/notebroker/cli.rb
+- lib/notebroker/error.rb
+- lib/notebroker/lexer.rb
+- lib/notebroker/markdown.rb
+- lib/notebroker/version.rb
+homepage: https://github.com/nolantait/notebroker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nolantait/notebroker
+  source_code_uri: https://github.com/nolantait/notebroker
+  changelog_uri: https://github.com/nolantait/notebroker
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A gem for turning notebooks into other formats
+test_files: []