Fix flatten name bug

Author: anyrepo

pybeeryaml/__init__.py

@@ -28,10 +28,22 @@
 from pybeeryaml.mash import MashProfile, MashStep
 
 
-__all__ = ["Recipe", "Hop", "Yeast", "Misc", "Water", "Style", "Fermentable",
-           "MashProfile", "MashStep", "__version__", "__author__", "__url__",
-           "__email__"]
-__version__ = "1.0"
+__all__ = [
+    "Recipe",
+    "Hop",
+    "Yeast",
+    "Misc",
+    "Water",
+    "Style",
+    "Fermentable",
+    "MashProfile",
+    "MashStep",
+    "__version__",
+    "__author__",
+    "__url__",
+    "__email__",
+]
+__version__ = "1.1"
 __author__ = "TROUVERIE Joachim"
 __email__ = "joachim.trouverie@linoame.fr"
 __url__ = "https://github.com/j0ack/pybeeryaml"

pybeeryaml/fermentable.py

@@ -22,6 +22,7 @@
 
 
 class Fermentable(BeerComponent):
+    """Fermentable class"""
 
     def __init__(self, name, type, amount, color, beeryaml_yield, **kwargs):
         super().__init__()

pybeeryaml/hop.py

@@ -22,6 +22,7 @@
 
 
 class Hop(BeerComponent):
+    """Hop class"""
 
     def __init__(self, name, alpha, amount, use, time, **kwargs):
         super().__init__()

pybeeryaml/mash.py

@@ -22,6 +22,7 @@
 
 
 class MashProfile(BeerComponent):
+    """Mash profile class"""
 
     def __init__(self, name, grain_temp, **kwargs):
         super().__init__("mash")
@@ -34,8 +35,7 @@ def __init__(self, name, grain_temp, **kwargs):
     def to_yaml(self) -> dict:
         """Convert object to YAML dict"""
         output = {
-            k: v for k, v in self.__dict__.items()
-            if not k.startswith("_")
+            k: v for k, v in self.__dict__.items() if not k.startswith("_")
         }
         output["mash_steps"] = {}
         for step in getattr(self, "mash_steps", []):
@@ -45,6 +45,7 @@ def to_yaml(self) -> dict:
 
 
 class MashStep(BeerComponent):
+    """Mash step class"""
 
     def __init__(self, name, type, step_time, step_temp, **kwargs):
         super().__init__("mash_step")

pybeeryaml/misc.py

@@ -22,6 +22,7 @@
 
 
 class Misc(BeerComponent):
+    """Misc class"""
 
     def __init__(self, name, type, use, time, amount, **kwargs):
         super().__init__()

pybeeryaml/recipe.py

@@ -18,26 +18,34 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 
-from yaml import safe_load
 from keyword import iskeyword
+
+from yaml import safe_load
+
+from pybeeryaml.fermentable import Fermentable
 from pybeeryaml.hop import Hop
-from pybeeryaml.yeast import Yeast
+from pybeeryaml.mash import MashProfile, MashStep
 from pybeeryaml.meta import BeerComponent
 from pybeeryaml.misc import Misc
-from pybeeryaml.water import Water
 from pybeeryaml.style import Style
-from pybeeryaml.fermentable import Fermentable
-from pybeeryaml.mash import MashProfile, MashStep
+from pybeeryaml.water import Water
+from pybeeryaml.yeast import Yeast
 
 
 class Recipe(BeerComponent):
-    """Recipe model
-
-    :param data: dict recipe data
-    """
-
-    def __init__(self, name, type, style, brewer, batch_size, boil_size,
-                 boil_time, **data: dict):
+    """Recipe model"""
+
+    def __init__(
+        self,
+        name,
+        type,
+        style,
+        brewer,
+        batch_size,
+        boil_size,
+        boil_time,
+        **data: dict
+    ):
         super().__init__()
         self.name = name
         self.type = type
@@ -52,41 +60,40 @@ def __init__(self, name, type, style, brewer, batch_size, boil_size,
         if isinstance(self.style, dict):
             self.style = Style(**data["style"])
 
-        hops = self.flatten(data.get("hops", {}))
+        hops = Recipe.flatten(data.get("hops", {}))
         self.hops = [Hop(**hdata) for hdata in hops]
 
-        yeasts = self.flatten(data.get("yeasts", {}))
+        yeasts = Recipe.flatten(data.get("yeasts", {}))
         self.yeasts = [Yeast(**ydata) for ydata in yeasts]
 
-        ferments = self.flatten(data.get("fermentables", {}))
+        ferments = Recipe.flatten(data.get("fermentables", {}))
         self.fermentables = [Fermentable(**fdata) for fdata in ferments]
 
-        miscs = self.flatten(data.get("miscs", {}))
+        miscs = Recipe.flatten(data.get("miscs", {}))
         self.miscs = [Misc(**mdata) for mdata in miscs]
 
         profile = data.get("mash", {"name": "mash", "grain_temp": 25})
         self.mash = MashProfile(**profile)
 
         steps = []
         if hasattr(self.mash, "mash_steps"):
-            msdata = self.flatten(self.mash.mash_steps)
+            msdata = Recipe.flatten(self.mash.mash_steps)
             for mash_step in msdata:
                 steps.append(MashStep(**mash_step))
 
         self.mash.mash_steps = steps
 
-        waters = self.flatten(data.get("waters", {}))
+        waters = Recipe.flatten(data.get("waters", {}))
         self.waters = [Water(wdata) for wdata in waters]
 
-    def flatten(self, data: dict) -> list:
-        """Flatten yaml dict
-
-        :param data: YAML dict
-        """
+    @classmethod
+    def flatten(cls, data: dict) -> list:
+        """Flatten yaml dict"""
         output = []
         for key, value in data.items():
             if isinstance(value, dict):
-                value["name"] = key
+                if "name" not in value:
+                    value["name"] = key
 
                 for vkey, vvalue in value.items():
                     if iskeyword(vkey):
@@ -124,10 +131,7 @@ def to_yaml(self) -> dict:
 
     @classmethod
     def from_file(cls, filepath: str):
-        """Create recipe from YAML file
-
-        :param filepath: YAML file containing recipe data
-        """
+        """Create recipe from YAML file"""
         with open(filepath, "r") as fi:
             data = safe_load(fi.read())
         return cls(**data)

pybeeryaml/style.py

@@ -22,10 +22,26 @@
 
 
 class Style(BeerComponent):
-
-    def __init__(self, name, category, category_number, style_letter,
-                 style_guide, type, og_min, og_max, fg_min, fg_max, ibu_min,
-                 ibu_max, color_min, color_max, **kwargs):
+    """Style class"""
+
+    def __init__(
+        self,
+        name,
+        category,
+        category_number,
+        style_letter,
+        style_guide,
+        type,
+        og_min,
+        og_max,
+        fg_min,
+        fg_max,
+        ibu_min,
+        ibu_max,
+        color_min,
+        color_max,
+        **kwargs
+    ):
         super().__init__()
 
         self.name = name

pybeeryaml/water.py

@@ -22,9 +22,21 @@
 
 
 class Water(BeerComponent):
-
-    def __init__(self, name, amount, calcium, bicarbonate, sulfate, chloride,
-                 sodium, magnesium, ph, **kwargs):
+    """Water class"""
+
+    def __init__(
+        self,
+        name,
+        amount,
+        calcium,
+        bicarbonate,
+        sulfate,
+        chloride,
+        sodium,
+        magnesium,
+        ph,
+        **kwargs
+    ):
         super().__init__()
 
         self.name = name

pybeeryaml/yeast.py

@@ -22,6 +22,7 @@
 
 
 class Yeast(BeerComponent):
+    """Yeast class"""
 
     def __init__(self, name, type, form, amount, **kwargs):
         super().__init__()

tests/test_recipe.py

@@ -20,8 +20,10 @@
 
 import os.path
 import xml.etree.ElementTree as ET
-from yaml import safe_load
 from copy import copy
+
+from yaml import safe_load
+
 from pybeeryaml import Recipe
 
 
@@ -33,10 +35,9 @@ def xmltodict(data: ET.Element, root=True) -> dict:
             tagname = child.tag
             if tagname in output:
                 tagname = "{}{}".format(
-                    child.tag, len([
-                        k for k in output.keys()
-                        if k.startswith(child.tag)
-                    ]))
+                    child.tag,
+                    len([k for k in output.keys() if k.startswith(child.tag)]),
+                )
             output[tagname] = xmltodict(child, False)
         else:
             output[child.tag] = child.text
@@ -175,3 +176,58 @@ def remove_keys(data):
         data = safe_load(fi.read())
 
     assert data == remove_keys(recipe.to_yaml())
+
+
+def test_flatten():
+    data = {
+        "pale ale": {
+            "type": "Grain",
+            "amount": "4500g",
+            "color": "5.9EBC",
+            "yield": "78.0",
+        },
+        "caramel/crystal": {
+            "type": "Grain",
+            "amount": "350g",
+            "color": "120EBC",
+            "yield": "74.0",
+        },
+    }
+    expected = [
+        {
+            "name": "pale ale",
+            "type": "Grain",
+            "amount": "4500g",
+            "color": "5.9EBC",
+            "beeryaml_yield": "78.0",
+        },
+        {
+            "name": "caramel/crystal",
+            "type": "Grain",
+            "amount": "350g",
+            "color": "120EBC",
+            "beeryaml_yield": "74.0",
+        },
+    ]
+    assert Recipe.flatten(data) == expected
+
+
+def test_flatten_with_same_names():
+    data = {
+        "first hop": {
+            "name": "cascade",
+            "amount": "20g",
+            "use": "boil",
+            "time": "10min",
+            "alpha": "7.5%",
+        },
+        "second hop": {
+            "name": "cascade",
+            "amount": "20g",
+            "use": "boil",
+            "time": "20min",
+            "alpha": "7.5%",
+        },
+    }
+    assert len(Recipe.flatten(data)) == len(data)
+    assert Recipe.flatten(data) == list(data.values())